Instances API
Number of APIs: 105
A collection of available REST endpoints scoped to your unique instance.
ZUID
All named resources in this API have a unique identifier called a ZUID. For example an instance ZUID would like 8-f48cf3a682-7fthvk. The initial prefix, e.g. 8-, represents the type of resource it is. Every discreet resource has it's own prefix. To find a full list of supported ZUIDs and to learn more read the spec; https://github.com/zesty-io/zuid-specification
URLs
As you peruse the available endpoints you will see the URLs which can be requested. The following is an explanation of the URL structure and the significance of specific portions.
For example the URL https://8-f48cf3a682-7fthvk.api.zesty.io/v1/content/models/6-556370-8sh47g/items/7-b939a4-457q19/publishings/18-660e14-jpx715 would breakdown as follows;
| https:// | 8-f48cf3a682-7fthvk | .api.zesty.io/ | v1 | /content/models/6-556370-8sh47g | /items/7-b939a4-457q19 | /publishings/18-660e14-jpx715 |
|---|---|---|---|---|---|---|
| protocol | Your instances unique identifier | domain for the API | version of the API | path to a unique content model | path to a unique item which belongs to the prior model | path to a unique publishings record which belongs to the prior item |
Getting an Auth Token
There are two types of authorization; session and access tokens. Read more about them here https://zesty.org/apis/auth-api#user-authentication
-
/content-/content/models/items/batch - Update Multiple Items PUT {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/models/{{content_model_zuid}}/items/batch
-
/content-/content/links - Create a link POST {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/links
-
/content-/content/links - Get Link GET {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/links/{{link_zuid}}
-
/content-/content/links - Get Links GET {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/links
-
/content-/content/links - Update link PUT {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/links/{{link_zuid}}
-
/content-/content/links - Patch link PATCH {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/links/:link_zuid
-
/content-/content/links - Delete link DELETE {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/links/{{link_zuid}}
-
/content-/content/models - Get Content Model GET {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/models/{{content_model_zuid}}
-
/content-/content/models/fields - Get Field GET {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/models/{{content_model_zuid}}/fields/{{field_zuid}}
-
/content-/content/models - Update Content Model PUT {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/models/{{content_model_zuid}}