Data stores

Data stores are used to store data from scenarios or for transferring data in between individual scenarios or scenario runs. The following endpoints allow you to create and manage data stores.

List data stores

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-stores

Retrieves a collection of all data stores for a team with a given ID. Returned data stores are sorted by name in ascending order.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters

teamIdintegerRequired

The unique ID of the team whose data stores will be retrieved.

Example: 1

pg[sortBy]string · enumOptional

The value that will be used to sort returned entities by.

Possible values:

pg[offset]integerOptional

The number of entities you want to skip before getting entities you want.

pg[sortDir]string · enumOptional

The sorting order. It accepts the ascending and descending direction specifiers.

Possible values:

pg[limit]integerOptional

The maximum number of entities you want to get in the response.

Responses

200

Successful response

application/json

get

/data-stores

HTTPcURLJavaScriptPython

GET /api/v2/data-stores?teamId=1 HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "dataStores": [
    {
      "id": 137,
      "name": "Customers",
      "records": "0",
      "size": "0",
      "maxSize": "1048576",
      "teamId": 212,
      "datastructureId": 123
    }
  ],
  "pg": {
    "sortBy": "name",
    "sortDir": "asc",
    "offset": 0,
    "limit": 10
  }
}

Create data store

post

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-stores

Creates a new data store with data passed in the request body. In the response, it returns all details of the created data store.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body

application/json

namestringRequired

The data store name. The name must be at most 128 characters long and does not need to be unique.

teamIdintegerRequired

The unique ID of the team in which the data store will be created.

datastructureIdintegerRequired

The unique ID of the data structure that will be included in the data store. All data structures IDs for a given team can be retrieved from the List data structures endpoint.

maxSizeMBintegerRequired

The maximum size of the data store (defined in MB).

Responses

200

Successful response

application/json

post

/data-stores

HTTPcURLJavaScriptPython

POST /api/v2/data-stores HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "name": "Customers",
  "teamId": 212,
  "datastructureId": 178,
  "maxSizeMB": 1
}

200

Successful response

{
  "dataStore": {
    "id": 137,
    "name": "Customers",
    "records": "0",
    "size": "0",
    "maxSize": "1048576",
    "teamId": 212
  }
}

Delete data stores

delete

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-stores

Deletes data stores with given IDs and returns their IDs in the response. This endpoint allows deleting one or more data stores at once.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters

confirmedbooleanOptional

Confirms the deletion if a data store is included in at least one scenario. Confirmation is required because the scenario will stop working without the data store. If the parameter is missing or it is set to false an error code is returned and the resource is not deleted.

Example: true

teamIdintegerRequired

The unique ID of the team from which the data store will be deleted.

Example: 1

Body

application/json

or

Responses

200

Successful response

application/json

delete

/data-stores

HTTPcURLJavaScriptPython

DELETE /api/v2/data-stores?teamId=1 HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "ids": [
    137,
    1399
  ]
}

200

Successful response

{
  "dataStores": [
    137,
    1399
  ]
}

Get data store details

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-stores/{dataStoreId}

Retrieves details of a data store with a given ID.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

dataStoreIdintegerRequired

The ID of the data store. Get the dataStoreId from the List data stores endpoint.

Example: 137

Query parameters

Responses

200

Successful response

application/json

get

/data-stores/{dataStoreId}

HTTPcURLJavaScriptPython

GET /api/v2/data-stores/{dataStoreId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "dataStore": {
    "id": 137,
    "name": "Customers",
    "records": "0",
    "size": "0",
    "maxSize": "1048576",
    "teamId": 212
  }
}

Update data store

patch

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-stores/{dataStoreId}

Updates properties of a data store with a given ID in a team with a given ID by passing new values in the request body. In the response, it returns all details of the updated data store including properties that were not changed. Any property that is not provided will be left unchanged. This endpoint cannot be used to update data included in the data store - for this use the endpoints for managing data stores data.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

dataStoreIdintegerRequired

The ID of the data store. Get the dataStoreId from the List data stores endpoint.

Example: 137

Body

application/json

namestringOptional

The data store name. The name must be at most 128 characters long and does not need to be unique.

datastructureIdintegerOptional

The unique ID of the data structure included in the data store. All data structures IDs for a given team can be retrieved from the List data structures endpoint.

maxSizeMBintegerOptional

The maximum size of the data store (defined in MB).

Responses

200

Successful response

application/json

patch

/data-stores/{dataStoreId}

HTTPcURLJavaScriptPython

PATCH /api/v2/data-stores/{dataStoreId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "name": "Data store 2",
  "datastructureId": 9,
  "maxSizeMB": 3
}

200

Successful response

{
  "dataStore": {
    "id": 137,
    "name": "Customers",
    "records": "0",
    "size": "0",
    "maxSize": "1048576",
    "teamId": 212
  }
}