Overview

The Socotra API exposes all platform functionality and follows common conventions for resource interaction. Endpoints and types are described in a uniform manner on each API page.

While it is possible to use the OpenAPI Definition File as a source for auto-generated API clients, we recommend using the file primarily as a parsable, comprehensive index of the entire API surface. You may need to tweak clients automatically generated from the OpenAPI definition.

Additional Notes

• When an endpoint request completes successfully, it will return a 200 status, even if the response is the platform informing you of some kind of error. In this fashion, we distinguish between the platform domain and any abnormal results concerning HTTP requests themselves.

• By default, any collection in a request is optional unless particular usage necessitates the provision of a collection (in which case, the platform will return a response to indicate that). If a collection is listed as required but you have no apparent need to provide any values for the collection, it is always safe to provide an empty collection, which the platform will ignore.