List Roles
GET/accounts/{account_id}/roles
Get all available roles for an account.
Security
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Query Parameters
List Roles
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/roles \
-H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
-H "X-Auth-Key: $CLOUDFLARE_API_KEY"{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"description": "Administrative access to the entire Account",
"name": "Account Administrator",
"permissions": {
"analytics": {
"read": true,
"write": false
},
"billing": {
"read": true,
"write": false
},
"cache_purge": {
"read": true,
"write": false
},
"dns": {
"read": true,
"write": false
},
"dns_records": {
"read": true,
"write": false
},
"lb": {
"read": true,
"write": false
},
"logs": {
"read": true,
"write": false
},
"organization": {
"read": true,
"write": false
},
"ssl": {
"read": true,
"write": false
},
"waf": {
"read": true,
"write": false
},
"zone_settings": {
"read": true,
"write": false
},
"zones": {
"read": true,
"write": true
}
}
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000
}
}Returns Examples
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"description": "Administrative access to the entire Account",
"name": "Account Administrator",
"permissions": {
"analytics": {
"read": true,
"write": false
},
"billing": {
"read": true,
"write": false
},
"cache_purge": {
"read": true,
"write": false
},
"dns": {
"read": true,
"write": false
},
"dns_records": {
"read": true,
"write": false
},
"lb": {
"read": true,
"write": false
},
"logs": {
"read": true,
"write": false
},
"organization": {
"read": true,
"write": false
},
"ssl": {
"read": true,
"write": false
},
"waf": {
"read": true,
"write": false
},
"zone_settings": {
"read": true,
"write": false
},
"zones": {
"read": true,
"write": true
}
}
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000
}
}