OrgsAPI Tokens
updateOrgApiToken
Update an organization API token's display name or scoped privileges. Source IP restrictions are defined when the token is created.
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
org_id*string
Format
uuidapitoken_id*string
Format
uuidRequest Body
application/json
Request Body
Organization API token with scoped privileges
Note:
privileges is required to create the object, but may not be returned in the POST API response. Retrieve the token afterward to inspect it.
name*string
Display name of the organization API token
privileges?array<>
Access scopes and roles granted to the organization API token
Items
1 <= items <= 10src_ips?array<string>
Allowed source IP addresses or CIDRs from which the token may be used
Range
value <= 10Response Body
curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/apitokens/000000ab-00ab-00ab-00ab-0000000000ab" \ -H "Content-Type: application/json" \ -d '{ "name": "org_token_xyz", "privileges": [ { "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "role": "admin", "scope": "org" } ] }'Empty