Instances

Instances provide a way to separate data, without needing to create a new account. For example, you might create separate development and production instances, so that the data that is created during development and testing doesn't appear alongside your production data. As another example, you might create separate instances for each of the applications that you develop using EveryPoint, so that the data for each application is kept separate for easier management.

All data that is created in the API must be contained within an instance. By default, each account is provided with an initial instance accessible via /v3/instances/default.

Each instance provides its own unique set of endpoints in order to maintain the separation between data (e.g. each instance has its own files, functions, jobs, and webhook endpoints).

Get a list of instances

Returns a list of available instances. Each instance in the list is represented by its URI.

Route: /v3/instances
Method: GET

Sample response body:

{
  "success": true,
  "data": {
    "instances": [
      "/instances/default",
      "/instances/development",
      "/instances/production"
    ]
  }
}

Get details of an instance

Returns the details for an individual instance.

Route: /v3{instance-uri}
Method: GET

Sample response body:

{
  "success": true,
  "data": {
    "instance": {
      "uri": "/instances/default",
      "name": "default",
      "description": "The default instance provided by the API."
    }
  }
}

Create an instance

Create a new instance.

Route: /v3/instances
Method: POST

When creating an instance, a name and description must be provided. The name of the instance is limited to lowercase letters, numbers, and hyphens.

Sample request body:

{
  "name": "development",
  "description": "Instance used for development."
}

Upon successful creation of an instance, the response will contain the details of the newly created instance.

Update an instance

Update the name or description of an instance.

Route: /v3{instance-uri}
Method: PATCH

The name or description of an instance can be updated via a PATCH request, where the body of the request contains the new name and/or description.

Sample request body:

{
  "name": "dev",
  "description": "Instance used for development."
}

Upon successfully updating an instance, the response will contain the updated details of the instance.

Delete an instance

Delete an instance.

When an instance is deleted, any data contained within it will no longer be accessible.

Route: /v3{instance-uri}
Method: DELETE

Sample response body:

{
  "success": true
}