/projects/count
This endpoint enables you to retrieve the overall number of projects you have.
name
string
Filter for projects names that contain this value. The API can return partial matches.
basicAuth
Successful response
count
int
The number of projects.
This response does not contain any headers
Successful response
{
"count": 37
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
/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.
page_size
int
Number of records per page.
page
int
Page number to retrieve.
name
string
Filter for projects names that contain this value.
sort_by
string
Select a property to sort by. Allowed values: created_at
, name
.
sort_order
string
Select the order to sort by. Allowed values: asc
, desc
.
basicAuth
Successful response
items
array[object]
object
project_id
string
The unique ID of a project.
created_at
string
The date when the project was created. This field uses the ATOM date-time format: 2024-02-05T00:00:00+01:00
name
string
The name of the project. Also visible in the dashboard. You may set any value that fits your organization purposes.
deletes_at
string or null
The scheduled date for deletion. The value is generally the first day of the next month. This field uses the ATOM date-time format: 2024-02-05T00:00:00+01:00
region
string
The region where your data is hosted.
deleted
boolean
When true, the project is currently being deleted. The project will disappear from your projects' list after deletion finishes. You should not use projects that return true
for deleted
.
pagination
object (pagination)
page
int
Returns the number of the currently active page.
page_size
int
Returns the number of items per page.
item_count
int
Returns the total number of items.
links
array[object]
object
rel
string
The relationship between the current page and the linked pages. Allowed values:
previous
: The link in href
points to the previous page when the current page is more than 1.self
: The link in href
points to the current page.next
: The link in href
points to the next page when there are more pages available. You can use this link to retrieve the next page of items or create an infinite scroll.href
string
The URL path of the linked page.
This response does not contain any headers
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"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
/projects
This endpoint enables you to create a new project and select the hosting region for it.
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.
basicAuth
Project created successfully
project_id
string
The unique ID of a project.
created_at
string
The date when the project was created. This field uses the ATOM date-time format: 2024-02-05T00:00:00+01:00
name
string
The name of the project. Also visible in the dashboard. You may set any value that fits your organization purposes.
deletes_at
string or null
The scheduled date for deletion. The value is generally the first day of the next month. This field uses the ATOM date-time format: 2024-02-05T00:00:00+01:00
region
string
The region where your data is hosted.
deleted
boolean
When true, the project is currently being deleted. The project will disappear from your projects' list after deletion finishes. You should not use projects that return true
for deleted
.
This response does not contain any headers
{
"name": "string",
"region": "us-east-1"
}
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
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
/projects/{project_id}
This endpoint enables you to retrieve a specific project based on its project_id
.
project_id
string
required
The ID of the project you want to retrieve.
basicAuth
Successful response
project_id
string
The unique ID of a project.
created_at
string
The date when the project was created. This field uses the ATOM date-time format: 2024-02-05T00:00:00+01:00
name
string
The name of the project. Also visible in the dashboard. You may set any value that fits your organization purposes.
deletes_at
string or null
The scheduled date for deletion. The value is generally the first day of the next month. This field uses the ATOM date-time format: 2024-02-05T00:00:00+01:00
region
string
The region where your data is hosted.
deleted
boolean
When true, the project is currently being deleted. The project will disappear from your projects' list after deletion finishes. You should not use projects that return true
for deleted
.
This response does not contain any headers
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
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
/projects/{project_id}
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.
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.
basicAuth
project_id
string
required
The ID of the project you want to update.
Project updated successfully
project_id
string
The unique ID of a project.
created_at
string
The date when the project was created. This field uses the ATOM date-time format: 2024-02-05T00:00:00+01:00
name
string
The name of the project. Also visible in the dashboard. You may set any value that fits your organization purposes.
deletes_at
string or null
The scheduled date for deletion. The value is generally the first day of the next month. This field uses the ATOM date-time format: 2024-02-05T00:00:00+01:00
region
string
The region where your data is hosted.
deleted
boolean
When true, the project is currently being deleted. The project will disappear from your projects' list after deletion finishes. You should not use projects that return true
for deleted
.
This response does not contain any headers
{
"name": "string",
"deletes_at": "next_cycle"
}
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
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Was this page helpful?