Admin - Project

APIs for project administration: settings, metrics, counters, and content statistics.

Get Project's Metrics GET

Returns usage metrics for the project (API calls, storage, etc.).

GET /{project}/admin/metrics

Path Parameters

Name	Type	Required	Description
project	string	Yes	-

Response (200 OK)

{
  "metrics": {
    "key": "value"
  }
}

cURL Example

curl -X GET "https://my-project.atlascms.io/{project}/admin/metrics" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Get Counters GET

Returns counter statistics for the project.

GET /{project}/admin/reports/counters

Path Parameters

Name	Type	Required	Description
project	string	Yes	-

Response (200 OK)

{
  "models": 0,
  "locales": 0,
  "users": 0,
  "images": 0,
  "videos": 0,
  "documents": 0,
  "contents": 0,
  "assetsSize": [
    {
      "key": "string",
      "value": 0
    }
  ]
}

cURL Example

curl -X GET "https://my-project.atlascms.io/{project}/admin/reports/counters" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Get Content Stats GET

Returns content statistics per model (published/unpublished counts).

GET /{project}/admin/reports/contents

Path Parameters

Name	Type	Required	Description
project	string	Yes	-

Response (200 OK)

{
  "totals": [
    {
      "name": "string",
      "published": 0,
      "unpublished": 0
    }
  ],
  "locales": [
    {
      "name": "string",
      "published": 0,
      "unpublished": 0
    }
  ]
}

cURL Example

curl -X GET "https://my-project.atlascms.io/{project}/admin/reports/contents" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Get Projects GET

Lists all projects accessible to the authenticated account.

GET /projects

Response (200 OK)

[
  {
    "id": "string",
    "displayName": "string",
    "instance": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2024-01-15T12:00:00Z",
    "createdBy": "string",
    "modifiedAt": "2024-01-15T12:00:00Z",
    "modifiedBy": "string",
    "locales": [
      {
        "locale": "string",
        "isDefault": true
      }
    ]
  }
]

cURL Example

curl -X GET "https://{project}.atlascms.io/projects" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Create Project POST

Creates a new project. Each project is an independent content environment.

POST /projects

Request Body

{
  "name": "string",
  "description": "string",
  "defaultLocale": "string"
}

Response (200 OK)

{
  "result": "string"
}

cURL Example

curl -X POST "https://{project}.atlascms.io/projects" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"name":"string","description":"string","defaultLocale":"string"}'

Get Project GET

Retrieves project details and configuration.

GET /{project}

Path Parameters

Name	Type	Required	Description
project	string	Yes	-

Response (200 OK)

{
  "id": "string",
  "displayName": "string",
  "instance": "string",
  "name": "string",
  "description": "string",
  "createdAt": "2024-01-15T12:00:00Z",
  "createdBy": "string",
  "modifiedAt": "2024-01-15T12:00:00Z",
  "modifiedBy": "string",
  "locales": [
    {
      "locale": "string",
      "isDefault": true
    }
  ]
}

cURL Example

curl -X GET "https://my-project.atlascms.io/{project}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Update Project PUT

Updates project settings such as name and description.

PUT /{project}

Path Parameters

Name	Type	Required	Description
project	string	Yes	-

Request Body

{
  "name": "string",
  "description": "string"
}

Response (200 OK)

{
  "id": "string",
  "displayName": "string",
  "instance": "string",
  "name": "string",
  "description": "string",
  "createdAt": "2024-01-15T12:00:00Z",
  "createdBy": "string",
  "modifiedAt": "2024-01-15T12:00:00Z",
  "modifiedBy": "string",
  "locales": [
    {
      "locale": "string",
      "isDefault": true
    }
  ]
}

cURL Example

curl -X PUT "https://my-project.atlascms.io/{project}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"name":"string","description":"string"}'