Update Token

PUT

https://api.cloudflare.com/client/v4/user/tokens/{identifier}

Last modified:2022-12-16 13:48:35

Update an existing token.

Request

Path Params

identifier

string

required

Body Params application/json

condition

object

condition

optional

request.ip

object

request.ip

optional

Client IP restrictions.

Example:

{"in":["123.123.123.0/24","2606:4700::/32"],"not_in":["123.123.123.100/24","2606:4700:4700::/48"]}

expires_on

string <date-time>

expires_on

optional

The expiration time on or after which the JWT MUST NOT be accepted for processing.

Example:

2020-01-01T00:00:00Z

name

string

Cloudflare Client API_name

required

Token name.

<= 120 characters

Example:

readonly token

not_before

string <date-time>

not_before

optional

The time before which the token MUST NOT be accepted for processing.

Example:

2018-07-01T05:20:00Z

policies

array[null (access-policy) {1}]

Cloudflare Client API_policies

required

List of access policies assigned to the token.

object

policy_with_permission_groups

optional

status

enum<string>

status

required

Status of the token.

Allowed values:

activedisabledexpired

Example:

active

Example

{
    "condition": {
        "request.ip": {
            "in": [
                "123.123.123.0/24",
                "2606:4700::/32"
            ],
            "not_in": [
                "123.123.123.100/24",
                "2606:4700:4700::/48"
            ]
        }
    },
    "expires_on": "2020-01-01T00:00:00Z",
    "name": "readonly token",
    "not_before": "2018-07-01T05:20:00Z",
    "policies": [
        {
            "effect": "allow",
            "permission_groups": [
                {
                    "id": "c8fed203ed3043cba015a93ad1616f1f",
                    "name": "Zone Read"
                },
                {
                    "id": "82e64a83756745bbbb1c9c2701bf816b",
                    "name": "DNS Read"
                }
            ],
            "resources": {
                "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*",
                "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*"
            }
        }
    ],
    "status": "active"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/user/tokens/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "condition": {
        "request.ip": {
            "in": [
                "123.123.123.0/24",
                "2606:4700::/32"
            ],
            "not_in": [
                "123.123.123.100/24",
                "2606:4700:4700::/48"
            ]
        }
    },
    "expires_on": "2020-01-01T00:00:00Z",
    "name": "readonly token",
    "not_before": "2018-07-01T05:20:00Z",
    "policies": [
        {
            "effect": "allow",
            "permission_groups": [
                {
                    "id": "c8fed203ed3043cba015a93ad1616f1f",
                    "name": "Zone Read"
                },
                {
                    "id": "82e64a83756745bbbb1c9c2701bf816b",
                    "name": "DNS Read"
                }
            ],
            "resources": {
                "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*",
                "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*"
            }
        }
    ],
    "status": "active"
}'

Responses

🟢200Update Token response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Update Token response failure

Modified at 2022-12-16 13:48:35

Token Details

Roll Token