Documentation is out of date

[gmariani]

I'm reviewing the documentation and it's missing a lot of items the native portal uses. Such as:

/api/v1/service/cloud-account/{site id}/apm/storage
/cloud-account/{site id}/domain-dns-info
/api/v1/site/{site id}/ftp

Any plans to update the documentation to be parity with what is live on the portal? Is there any API that can grab all the DNS status of all the sites within a Plan/Service instead of going site by site?

[adrian-enspired]

Any plans to update the documentation to be parity with what is live on the portal?

The portal still uses some legacy endpoints which are not designed for customer use, and will eventually be removed. Documentation for all "v1" endpoints is planned, yes.

Is there any API that can grab all the DNS status of all the sites within a Plan/Service?

The list endpoints for DNS zones, records, etc. cannot currently be filtered by Service or Site - the relationship there is indirect. This might be something useful to add, though.

You can filter DNS Records by the Zone they belong to.

[gmariani]

Is there any API that can grab all the DNS status of all the sites within a Plan/Service?

Ah, I'm sorry, I think you misunderstood. So for reference, we have about 300+ sites hosted with Nexcess at this point and are constantly getting clients to point their DNS to Nexcess as we continue migrating sites. But it's not always easy to keep track of when a site needs it's SSL configured (since this is not done automatically). So I built a report using the API to query every Site's SSL/Domain status. I do this to check if the DNS is 1) pointed to the Site, and 2) ready to grab the SSL. But I currently have to check every site separately and it takes a good 5minutes to process all our sites. Versus just a single endpoint I could query the status of all our sites at once.

Glad to hear about the documentation, when I started I basically just had to navigate the portal to document all the endpoints and find out how they actually worked because the documentation was sorely lacking (which was almost 9 months ago at this point).

[adrian-enspired]

I see. We don't have an endpoint for this planned, but sounds like it could be useful. I couldn't say for sure when / if we would implement it, but I'll write it down and see what I can do.

I'm glad to hear you're making good use of the api. We've been working towards an official version 1 release, but aren't there yet. You're welcome to use the Api but please be aware it's "at your own risk" and things may still change without notice.