zesty.io
Log in

Guides

API Reference

Language:

/instances

POST

Create Instance

Creates an instance. This will automatically generate a new instance ZUID and the user making the Create Instance request will be set as the Owner.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID

Request Body

{
  "name": "Test Instance with database defaults"
}
POST

Create Instance with an ecosystem ID

Creates an instance with an ecosystem.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID

Request Body

{
    "name": "Test Instance Name",
    "ecoZUID": "{{ecosystem_zuid}}"
}
POST

Verify DNS

Verifies a DNS record matches a CName or A record

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/dns
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID

Request Body

{
  "domain": "www.google.com",
  "aRecord": "172.217.14.68",
  "cName": "www.google.com"
}
GET

Get Instance

Gets a single instance by its ZUID

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/8-xxxxxxxxx
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID
GET

Get All Instances

Gets all instances a user has access to.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID
GET

Get All Invited Instances

Gets all instances a user has been invited to.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/invites
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID
GET

Get Instance Users

Gets a single instance's users.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/8-xxxxxxxxx/users
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID
GET

Get Instance Users With Roles

Gets a single instance's users with their instance-based role attached.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/8-xxxxxxxxx/users/roles
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID
GET

Get Instance Pending Users

Gets a single instance's pending users.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/8-xxxxxxxxx/users/pending
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID
GET

Get Instance Companies

Gets a single instance's companies.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/8-xxxxxxxxx/companies
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID
PUT

Update Instance

Update permissions for a given user and content instance. Takes one of following values for the query param action.

  • updateEcosystem
  • updateDomain
  • updateBlueprint
  • purgeCache
Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/8-xxxxxxxxx
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID

Request Body

{
    "name": "Updated Instance Name"
}
PUT

Update Instance Blueprint

Erases the current instance and replaces instance with the specified blueprint

Warning: This is a destructive action and is NOT reversible.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/8-xxxxxxxxx/blueprints
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID

Request Body

{
    "blueprintZUID": "{{blueprint_zuid}}"
}
PUT

Purge Instance

Update permissions for a given user and content instance. Takes one of following values for thea query param action.

  • updateEcosystem
  • updateDomain
  • updateBlueprint
  • purgeCache
Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/8-xxxxxxxxx?action=purgeCache
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID
DELETE

Delete Instance

Deletes a single instance.

Please sign in to view your instance’s unique identifier

URL Endpoint

https://accounts.api.zesty.io/v1/instances/8-xxxxxxxxx
Please sign in to view your token

Authentication Header

Bearer YOUR_APP_SID
;