Sign up for free

Get project count

This endpoint enables you to retrieve the overall number of projects you have.

get /projects/count
name string

Filter for projects names that contain this value. The API can return partial matches.

Responses

ExamplesSchema

Successful response

{
  "count": 37
}

List projects

This endpoint enables you to retrieve a paginated list of every project you have. You can filter the list by project name, and sort by name, creation date, and ascending or descending order.

Note that the API response only contains one page of results. To navigate to another page, use the previous or next path queries provided in the respone's links object.

get /projects
page_size int

Number of records per page.

Default
20
Max
100
page int

Page number to retrieve.

Default
1
name string

Filter for projects names that contain this value.

sort_by string

Select a property to sort by. Allowed values: created_at, name.

Enum
  • created_at
  • name
sort_order string

Select the order to sort by. Allowed values: asc, desc.

Enum
  • asc
  • desc

Responses

ExamplesSchema

Successful response

{
  "items": [
    {
      "project_id": "project_1CCq9NurjJBRehCVCe8XQY",
      "created_at": "2023-06-07T17:32:28Z",
      "name": "My project",
      "deletes_at": "2023-06-07T17:32:28Z",
      "region": "us-east-1",
      "deleted": true
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "item_count": 123
  },
  "links": [
    {
      "rel": "previous",
      "href": "/projects?page_size=20&name=aaa&sort_by=name&sort_order=desc&page=2"
    }
  ]
}

Create project

This endpoint enables you to create a new project and select the hosting region for it.

post /projects
name string

required

The name of the Admin API key. Also visible in the dashboard. You may set any value that fits your organization purposes.

region string

required

The region where your data is hosted.

Enum
  • us-east-1
  • eu-central-1

Requests

{
  "name": "string",
  "region": "us-east-1"
}

Responses

ExamplesSchema

Project created successfully

{
  "project_id": "project_1CCq9NurjJBRehCVCe8XQY",
  "created_at": "2023-06-07T17:32:28Z",
  "name": "My project",
  "deletes_at": "2023-06-07T17:32:28Z",
  "region": "us-east-1",
  "deleted": true
}

Get project

This endpoint enables you to retrieve a specific project based on its project_id.

get /projects/{project_id}
project_id string

required

The ID of the project you want to retrieve.

Responses

ExamplesSchema

Successful response

{
  "project_id": "project_1CCq9NurjJBRehCVCe8XQY",
  "created_at": "2023-06-07T17:32:28Z",
  "name": "My project",
  "deletes_at": "2023-06-07T17:32:28Z",
  "region": "us-east-1",
  "deleted": true
}

Update project

This endpoint enables you to update a specific project based on its project_id.

You can update the project name and schedule the project for deletion. When you schedule a project for deletion, the project will be deleted on the first day of the next billing cycle. The API sends the exact date-time of deletion in the response.

patch /projects/{project_id}
name string

required

The project name that you want to update.

deletes_at string

Schedule the project for deletion. The accepted value is next_cycle. The project will be deleted on the first day of the next billing cycle. The API sends the exact date-time of deletion in the response.

Enum
  • next_cycle

Requests

{
  "name": "string",
  "deletes_at": "next_cycle"
}

Responses

ExamplesSchema

Project updated successfully

{
  "project_id": "project_1CCq9NurjJBRehCVCe8XQY",
  "created_at": "2023-06-07T17:32:28Z",
  "name": "My project",
  "deletes_at": "2023-06-07T17:32:28Z",
  "region": "us-east-1",
  "deleted": true
}

Was this page helpful?