Release
API docs by Redocly

Datasets API V1 (v1)

Download OpenAPI specification:Download

The Release Datasets API is a RESTful API that allows you to manage your datasets in Release. It provides endpoints for creating, updating, and deleting datasets, as well as checking out databases.

Release Docs

Cloud Integrations

List cloud integrations

Authorizations:
account_api_key
header Parameters
X-Account-ID
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a new cloud integration

Authorizations:
user_api_key
header Parameters
X-Account-ID
required
string
X-User-Email
required
string
Request Body schema: application/json
object (cloud_integration_input)

Responses

Request samples

Content type
application/json
Example
{
  • "cloud_integration": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": 248,
  • "name": "My AWS Integration",
  • "type": "aws",
  • "credentials_configured": false,
  • "created_at": "2023-07-21T13:49:26.798Z",
  • "updated_at": "2023-07-21T13:49:26.798Z"
}

Get cloud integration launch stack URL

This endpoint returns a URL that can be used to launch a cloud integration stack on the provider.

Authorizations:
account_api_key
path Parameters
id
required
string
header Parameters
X-Account-ID
required
string

Responses

Response samples

Content type
application/json
{
  • "launch_stack_url": "string"
}

Update cloud integration

Authorizations:
account_api_key
path Parameters
id
required
string
header Parameters
X-Account-ID
required
string
Request Body schema: application/json
object (cloud_integration_update_input)

Responses

Request samples

Content type
application/json
Example
{
  • "cloud_integration": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": 251,
  • "name": "My AWS Integration",
  • "type": "aws",
  • "credentials_configured": true,
  • "created_at": "2023-07-21T13:49:26.904Z",
  • "updated_at": "2023-07-21T13:49:26.910Z"
}

Delete cloud integration

This endpoint deletes a cloud integration. Note that only owners of the account can delete a cloud integration.

Authorizations:
user_api_key
path Parameters
id
required
string
header Parameters
X-Account-ID
required
string
X-User-Email
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Datasets

List databases in a dataset

Authorizations:
account_api_key
path Parameters
id
required
string

Dataset ID

header Parameters
X-Account-ID
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List datasets

Authorizations:
account_api_key
header Parameters
X-Account-ID
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new dataset

Authorizations:
account_api_key
header Parameters
X-Account-ID
required
string
Request Body schema: application/json
cloud_integration_id
integer
object (dataset_input)

Responses

Request samples

Content type
application/json
Example
{
  • "cloud_integration_id": 259,
  • "dataset": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": 1234,
  • "name": "test-dataset",
  • "type": "rds",
  • "state": "created",
  • "buffered_item_count": 1,
  • "created_at": "2023-07-21T13:49:27.220Z",
  • "updated_at": "2023-07-21T13:49:27.220Z",
  • "configuration": {
    }
}

Update an existing dataset

Updates a dataset buffer size, instance type and/or password.

Password changes only affect available and new instances. Existing databases that are already in use will not be affected. If there are size/instance type changes as well as password changes, the password changes will be performed after the pool is balanced.

Authorizations:
account_api_key
path Parameters
id
required
string
header Parameters
X-Account-ID
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "buffered_item_count": 1,
  • "instance_type": "db.t2.micro",
  • "password": "new-password"
}

Response samples

Content type
application/json
{
  • "id": 170,
  • "name": "pool-3e0dccbc5fd6e6818cb22407e22d7adc-5",
  • "type": "rds",
  • "state": "created",
  • "buffered_item_count": 1,
  • "created_at": "2023-07-21T13:49:27.301Z",
  • "updated_at": "2023-07-21T13:49:27.301Z",
  • "configuration": {
    }
}

Delete an existing dataset

Authorizations:
account_api_key
path Parameters
id
required
string
header Parameters
X-Account-ID
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Checkout a database from a dataset

Checks out an available database from the dataset for the current user.

This will trigger a balance on the dataset to ensure it has enough available databases.

Authorizations:
user_api_key
path Parameters
id
required
string
header Parameters
X-User-Email
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 103,
  • "state": "in_use",
  • "name": "rds-3",
  • "hostname": "rds-3.us-east-1.rds.amazonaws.com",
  • "username": "admin",
  • "password": "password"
}

Check-in a database from a dataset

Checks in an the database in use for the current user. This will remove the database.

This will trigger a balance on the dataset to ensure it has enough available databases.

Authorizations:
user_api_key
path Parameters
id
required
string
header Parameters
X-User-Email
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 104,
  • "state": "removing",
  • "name": "rds-4",
  • "hostname": "rds-4.us-east-1.rds.amazonaws.com",
  • "username": "admin",
  • "password": "password"
}

Databases

List databases in a dataset

Authorizations:
account_api_key
path Parameters
id
required
string

Dataset ID

header Parameters
X-Account-ID
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show a database

Authorizations:
account_api_key
path Parameters
id
required
string

Database ID

header Parameters
X-Account-ID
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 102,
  • "state": "available",
  • "name": "rds-2",
  • "hostname": "rds-2.us-east-1.rds.amazonaws.com",
  • "username": "admin",
  • "password": "password"
}