Projects

List Projects

get

List all projects user has access to.

Optionally filter by team_id.

Query parameters
team_idany ofOptional

Filter by team ID

stringOptional
or
nullOptional
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/admin/projects

Create Project

post

Create a new project.

Requires: team_admin role or higher for the parent team

Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Body

Request model for creating a project.

project_namestring · min: 1 · max: 100Required
team_idstringRequired

Parent team ID

descriptionany ofOptional
string · max: 500Optional
or
nullOptional
allowed_servicesany ofOptional

Services this project can access

string[]Optional
or
nullOptional
rate_limitany ofOptional
integer · min: 1 · max: 10000Optional
or
nullOptional
Responses
post
/v1/admin/projects

Get Project

get

Get project details.

User must have access to the project's team.

Path parameters
project_idstringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/admin/projects/{project_id}

Delete Project

delete

Delete (soft delete) a project.

Requires: team_admin or org_admin role

Path parameters
project_idstringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Responses
delete
/v1/admin/projects/{project_id}

No content

Update Project

patch

Update project details.

Requires: project_admin role or higher

Path parameters
project_idstringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Body

Request model for updating a project.

project_nameany ofOptional
string · min: 1 · max: 100Optional
or
nullOptional
descriptionany ofOptional
string · max: 500Optional
or
nullOptional
allowed_servicesany ofOptional
string[]Optional
or
nullOptional
rate_limitany ofOptional
integer · min: 1 · max: 10000Optional
or
nullOptional
enable_audit_logany ofOptional
booleanOptional
or
nullOptional
Responses
200

Successful Response

application/json
patch
/v1/admin/projects/{project_id}

Get Project Metadata

get

Get project metadata.

If key is provided, returns only that key's value. Otherwise, returns all metadata.

Path parameters
project_idstringRequired
Query parameters
keyany ofOptional

Specific metadata key to retrieve

stringOptional
or
nullOptional
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/admin/projects/{project_id}/metadata

Set Project Metadata

put

Set or update a specific metadata key.

Requires: project_admin role or higher

Path parameters
project_idstringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Body

Request to set metadata key.

keystringRequired
valueanyRequired
Responses
200

Successful Response

application/json
put
/v1/admin/projects/{project_id}/metadata

Merge Project Metadata

patch

Merge multiple metadata keys at once.

Existing keys are updated, new keys are added. Requires: project_admin role or higher

Path parameters
project_idstringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Body
Other propertiesanyOptional
Responses
200

Successful Response

application/json
patch
/v1/admin/projects/{project_id}/metadata

Delete Project Metadata

delete

Delete a specific metadata key.

Requires: project_admin role or higher

Path parameters
project_idstringRequired
keystringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
delete
/v1/admin/projects/{project_id}/metadata/{key}

List Project Members

get

List all members of a project.

Requires: read:project permission

Path parameters
project_idstringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/v1/admin/projects/{project_id}/members

Add Project Member

post

Add a member to a project.

Requires: manage:project_users permission

Path parameters
project_idstringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Body

Request to add a member to a project.

user_idany ofOptional
stringOptional
or
nullOptional
user_emailany ofOptional
stringOptional
or
nullOptional
rolestring · enumOptional

Project role (project_admin, editor, viewer)

Default: viewerPossible values:
Responses
post
/v1/admin/projects/{project_id}/members

No content

Bulk Add Project Members

post

Bulk add members to a project.

  • Max 100 users per request

  • Returns success/failure per user

  • Requires: manage:project_users permission

Path parameters
project_idstringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Body

Request to bulk add members to a project.

user_idsstring[] · min: 1 · max: 100Required

List of user IDs (max 100)

rolestring · enumOptional

Role to assign to all users (project_admin, editor, viewer)

Default: viewerPossible values:
Responses
post
/v1/admin/projects/{project_id}/members/bulk

No content

Remove Project Member

delete

Remove a member from a project.

Requires: manage:project_users permission

Path parameters
project_idstringRequired
user_idstringRequired
Header parameters
authorizationany ofOptional
stringOptional
or
nullOptional
X-Atlas-API-Keyany ofOptional
stringOptional
or
nullOptional
Responses
delete
/v1/admin/projects/{project_id}/members/{user_id}

No content

Last updated