Create integration
POST/accounts/{account_id}/one/integrations
Creates a new integration for the specified application. Integration creation with OAuth is not supported by API at the moment. For other auth methods, use GET /v2/applications/{application_id}/credential-guide to see the required credential structure and example payloads for each vendor.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
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:
Body ParametersJSON
Create integration
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/one/integrations \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-d '{
"application": "GOOGLE_WORKSPACE",
"credentials": {
"admin_email": "bar"
},
"name": "My Google Workspace"
}'{
"errors": [],
"messages": [],
"result": {
"application": {
"category": "Productivity",
"display_name": "Google Workspace",
"logo": "https://onprem.cloudflare.com/static/google_workspace.png"
},
"auth_method": {
"display_name": "OAuth 2.0",
"id": "oauth"
},
"authorization_link": {
"components": {
"client_id": "abc",
"instance_name": "example"
},
"link": "https://example.cloudflare.com/authorize"
},
"created": "2025-01-01T00:00:00Z",
"credentials_expiry": "2026-01-01T00:00:00Z",
"dlp_profiles": [
"e91a2360-da51-4fdf-9711-bcdecd462614"
],
"health_details": [],
"id": "019d2e6a-d995-7185-afbd-4feead9e42ec",
"is_paused": false,
"last_hydrated": "2025-04-10T08:30:00Z",
"name": "My Google Workspace",
"organization_id": 1,
"status": "Healthy",
"updated": "2025-04-10T08:30:00Z",
"use_cases": [
{
"description": "Discover and secure SaaS applications",
"features": [
{
"description": "Automatically remediate security issues (requires write permissions)",
"id": "auto_remediation",
"is_enabled": true,
"name": "Auto Remediation",
"permissions": [
{
"display_name": "Manage users",
"scope": "https://www.googleapis.com/auth/admin.directory.user",
"status": "granted"
}
]
}
],
"id": "casb",
"is_enabled": true,
"name": "Cloud Access Security Broker",
"permissions": [
{
"display_name": "Drive (Read Only)",
"scope": "https://www.googleapis.com/auth/drive.readonly",
"status": "granted"
},
{
"display_name": "Gmail (Read Only)",
"scope": "https://www.googleapis.com/auth/gmail.readonly",
"status": "missing"
}
]
},
{
"description": "Protect against email-based threats",
"features": [],
"id": "ces",
"is_enabled": false,
"name": "Cloud Email Security",
"permissions": []
}
]
},
"success": true
}Returns Examples
{
"errors": [],
"messages": [],
"result": {
"application": {
"category": "Productivity",
"display_name": "Google Workspace",
"logo": "https://onprem.cloudflare.com/static/google_workspace.png"
},
"auth_method": {
"display_name": "OAuth 2.0",
"id": "oauth"
},
"authorization_link": {
"components": {
"client_id": "abc",
"instance_name": "example"
},
"link": "https://example.cloudflare.com/authorize"
},
"created": "2025-01-01T00:00:00Z",
"credentials_expiry": "2026-01-01T00:00:00Z",
"dlp_profiles": [
"e91a2360-da51-4fdf-9711-bcdecd462614"
],
"health_details": [],
"id": "019d2e6a-d995-7185-afbd-4feead9e42ec",
"is_paused": false,
"last_hydrated": "2025-04-10T08:30:00Z",
"name": "My Google Workspace",
"organization_id": 1,
"status": "Healthy",
"updated": "2025-04-10T08:30:00Z",
"use_cases": [
{
"description": "Discover and secure SaaS applications",
"features": [
{
"description": "Automatically remediate security issues (requires write permissions)",
"id": "auto_remediation",
"is_enabled": true,
"name": "Auto Remediation",
"permissions": [
{
"display_name": "Manage users",
"scope": "https://www.googleapis.com/auth/admin.directory.user",
"status": "granted"
}
]
}
],
"id": "casb",
"is_enabled": true,
"name": "Cloud Access Security Broker",
"permissions": [
{
"display_name": "Drive (Read Only)",
"scope": "https://www.googleapis.com/auth/drive.readonly",
"status": "granted"
},
{
"display_name": "Gmail (Read Only)",
"scope": "https://www.googleapis.com/auth/gmail.readonly",
"status": "missing"
}
]
},
{
"description": "Protect against email-based threats",
"features": [],
"id": "ces",
"is_enabled": false,
"name": "Cloud Email Security",
"permissions": []
}
]
},
"success": true
}