Cosmoner Docs
API Reference

Resource groups

Named boxes drawn around resources on the project overview's resource graph. Groups nest, a resource sits in at most one, and they change only how the project is drawn — nothing a group holds behaves any differently for being in it.

List resource groups

GET
/v1/projects/{projectId}/resource-groups

Every group in the project, ordered by name. Groups are named boxes drawn around resources on the project overview; a group with a parentId is nested inside that group.

Auth: a project API key carrying projects:read.

Authorization

apiKey
AuthorizationBearer <token>

A project API key. X-API-Key: <key> is accepted as an alternative to the Authorization header.

In: header

Path Parameters

projectId*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/projects/string/resource-groups"
{  "success": true,  "data": [    {      "id": "string",      "name": "string",      "parentId": "string"    }  ]}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}

Create a resource group

POST
/v1/projects/{projectId}/resource-groups

Creates a group at the top level, or inside parentId. Groups nest up to five levels deep, and a project can hold up to 100 of them.

Members with the viewer role cannot change groups.

Auth: a project API key carrying all of projects:read and projects:write.

Authorization

apiKey
AuthorizationBearer <token>

A project API key. X-API-Key: <key> is accepted as an alternative to the Authorization header.

In: header

Path Parameters

projectId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/projects/string/resource-groups" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "success": true,  "data": {    "id": "string",    "name": "string",    "parentId": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}

Rename or move a resource group

PATCH
/v1/projects/{projectId}/resource-groups/{groupId}

Renames the group, moves it, or both. Send parentId: null to move it to the top level; leave parentId out to keep it where it is. Its subgroups and resources move with it.

Members with the viewer role cannot change groups.

Auth: a project API key carrying all of projects:read and projects:write.

Authorization

apiKey
AuthorizationBearer <token>

A project API key. X-API-Key: <key> is accepted as an alternative to the Authorization header.

In: header

Path Parameters

projectId*string
Length1 <= length
groupId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/projects/string/resource-groups/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "data": {    "id": "string",    "name": "string",    "parentId": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}

Delete a resource group

DELETE
/v1/projects/{projectId}/resource-groups/{groupId}

Removes the group. Its resources and subgroups move up into its parent — or to the top level for a top-level group. No resource is changed or deleted.

Members with the viewer role cannot change groups.

Auth: a project API key carrying all of projects:read and projects:write.

Authorization

apiKey
AuthorizationBearer <token>

A project API key. X-API-Key: <key> is accepted as an alternative to the Authorization header.

In: header

Path Parameters

projectId*string
Length1 <= length
groupId*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/projects/string/resource-groups/string"
{  "success": true,  "data": null}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}

Place a resource in a group

PUT
/v1/projects/{projectId}/resource-groups/assignment

Puts a resource in a group, or takes it out of its group with groupId: null. A resource sits in at most one group, so placing it moves it out of any group it was in.

Container repositories and git repositories cannot be placed directly: a repository is shown in its registry's group, and a git repository with the apps that deploy from it.

Members with the viewer role cannot change groups.

Auth: a project API key carrying all of projects:read and projects:write.

Authorization

apiKey
AuthorizationBearer <token>

A project API key. X-API-Key: <key> is accepted as an alternative to the Authorization header.

In: header

Path Parameters

projectId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/projects/string/resource-groups/assignment" \  -H "Content-Type: application/json" \  -d '{    "kind": "app",    "resourceId": "string",    "groupId": "string"  }'
{  "success": true,  "data": {    "groupId": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}
{  "success": false,  "error": {    "code": "string",    "message": "string"  }}

Projects

A project is the unit of ownership and billing: every resource belongs to exactly one, and an API key reaches exactly one. Address a project by its `id` or its `slug` — both are accepted wherever `{projectId}` appears.

Members

API reference for project membership, invitations, and billing responsibility.

On this page

List resource groupsCreate a resource groupRename or move a resource groupDelete a resource groupPlace a resource in a group