Projects
REST API methods for interacting with Phoenix projects
Create a new project with the specified configuration.
POST /v1/projects HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"name": "text",
"description": "text"
}
{
"data": {
"name": "text",
"description": "text",
"id": "text"
}
}
Retrieve a paginated list of all projects in the system.
Cursor for pagination (project ID)
The max number of projects to return at a time.
100
Include experiment projects in the response. Experiment projects are created from running experiments.
false
GET /v1/projects HTTP/1.1
Host:
Accept: */*
{
"data": [
{
"name": "text",
"description": "text",
"id": "text"
}
],
"next_cursor": "text"
}
Retrieve a specific project using its unique identifier: either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
GET /v1/projects/{project_identifier} HTTP/1.1
Host:
Accept: */*
{
"data": {
"name": "text",
"description": "text",
"id": "text"
}
}
Update an existing project with new configuration. Project names cannot be changed. The project identifier is either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
PUT /v1/projects/{project_identifier} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"description": "text"
}
{
"data": {
"name": "text",
"description": "text",
"id": "text"
}
}
Delete an existing project and all its associated data. The project identifier is either project ID or project name. The default project cannot be deleted. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
DELETE /v1/projects/{project_identifier} HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?