How to access the API properly.

Rich

I am currently trying to access the API using Insomnia application.

I've set the barerer Token, per instruction, but you also state to prefix with orgId. I see some endpoints call for orgId, but otherwise /version is just that.

So far I've been unable to make a successful call I am trying domains like so, as this also isn't documented.

http://console.example.com/version
http://console.example.com/<orgId>/version
http://console.example.com/orgs/<orgId>/version
http://hostname.example.com/version
http://hostname.example.com/<orgId>/version
http://hostname.example.com/orgs/<orgId>/version

None worked. I've even tried adding the orgId as an extra header, still nothing. Heck I've even tried prefixing the bearer token with the orgId...

So what EXACTLY is the process for this? I get we'll be polling the enhance control panel server, but I am getting nothing.

Also, I am honestly not happy about this being http only?! that's very risky as there are plenty of MITM routers that suck up plaintext traffic. Can the api not be applied to the console? like the web UI? and use that service SSL?

Any assistance to get me in the right direction from anyone will be greatly appreciated. I no longer know if I am chasing my tail or what. 🙁

MediaServe

I've used curl to test the API before, and here's a sample call that works for me:

curl -s -X GET https://[Enhance Controller URL]/api/servers -H "Accept: application/json" -H "Authorization: Bearer [Token]" | jq

This displays data about the servers in the Enhance estate. Replace the two values in brackets it should help.

Rich

/api/ that's what's missing! Thank you MediaServe

https://console.example.com/api/version
with bearer set.

Rich

Also to follow up, 443 does work if you point it at the control panel domain with the service certificate.

It's always one little thing to get in the way. 😃

Rich

@Aliysa_Enhance

Could we please have the api documentation expanded to show the requirement of https://<control_panel>/api/.

Likewise the message within the control panel stating:

"To perform API operations you must send your access token as an HTTP header and prefix API requests with your orgId."

Make that HTTPS which is vitally important HTTP is a security leak. Likewise orgId isn't required for all API calls, this was throwing me thinking it was an exact requirement.

Thank you.

Aliysa_Enhance

Rich Leave this with me 🙂

necrom

As @Adam pointed out to me in a ticket https://github.com/OpenAPITools/openapi-generator is worth getting to grips with if you're just starting building API interactions, as it'll provide an abstraction layer between your code and the API calls that'll help reduce future breakage as the API matures.