Content Management API > API token

Update an API token

Body parameters

type string Required

Must be exactly "access_token".

attributes.name string Required

Name of API token

Example:

"Read-only API token"

attributes.can_access_cda boolean Required

Whether this API token can access the Content Delivery API published content endpoint

attributes.can_access_cda_preview boolean Required

Whether this API token can access the Content Delivery API draft content endpoint

attributes.can_access_cma boolean Required

Whether this API token can access the Content Management API

relationships.role.data Required

Role

Type: ResourceLinkage<"role">, null

Returns

Returns a resource object of type access_token.

Examples

1
PUT https://site-api.datocms.com/access_tokens/:access_token_id HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6

7
{
8
  "data": {
9
    "type": "access_token",
10
    "id": "312",
11
    "attributes": {
12
      "name": "Read-only API token",
13
      "can_access_cda": true,
14
      "can_access_cda_preview": true,
15
      "can_access_cma": true
16
    },
17
    "relationships": {
18
      "role": {
19
        "data": {
20
          "type": "role",
21
          "id": "34"
22
        }
23
      }
24
    }
25
  }
26
}

1
curl -g 'https://site-api.datocms.com/access_tokens/:access_token_id' \
2
  -X PUT \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3" \
6
  -H "Content-Type: application/vnd.api+json" \
7
  --data-binary '{"data":{"type":"access_token","id":"312","attributes":{"name":"Read-only API token","can_access_cda":true,"can_access_cda_preview":true,"can_access_cma":true},"relationships":{"role":{"data":{"type":"role","id":"34"}}}}}'

1
await fetch("https://site-api.datocms.com/access_tokens/:access_token_id", {
2
  method: "PUT",
3
  headers: {
4
    Authorization: "Bearer YOUR-API-TOKEN",
5
    Accept: "application/json",
6
    "X-Api-Version": "3",
7
    "Content-Type": "application/vnd.api+json",
8
  },
9
  body: JSON.stringify({
10
    data: {
11
      type: "access_token",
12
      id: "312",
13
      attributes: {
14
        name: "Read-only API token",
15
        can_access_cda: true,
16
        can_access_cda_preview: true,
17
        can_access_cma: true,
18
      },
19
      relationships: { role: { data: { type: "role", id: "34" } } },
20
    },
21
  }),
22
});

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": {
9
    "type": "access_token",
10
    "id": "312",
11
    "attributes": {
12
      "name": "Read-only API token",
13
      "hardcoded_type": "",
14
      "can_access_cda": true,
15
      "can_access_cda_preview": true,
16
      "can_access_cma": true
17
    },
18
    "relationships": {
19
      "role": {
20
        "data": {
21
          "type": "role",
22
          "id": "34"
23
        }
24
      }
25
    }
26
  }
27
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.