Cloudflare API | Organizations › Create Organization

Retrieve a list of organizations a particular user has access to. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Get Organization -> Envelope<

Organization

get/organizations/{organization_id}

Retrieve the details of a certain organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Create Organization -> Envelope<

Organization

post/organizations

Create a new organization for a user. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example: X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

User Details Write

Response fields

errors: Array<unknown>

messages: Array<

ResponseInfo

result:

Organization

References an Organization in the Cloudflare data model.

success: true

Request example

curl https://api.cloudflare.com/client/v4/organizations \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
          "name": "name"
        }'

200Example

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
    "create_time": "2019-12-27T18:11:19.117Z",
    "meta": {
      "flags": {
        "account_creation": "account_creation",
        "account_deletion": "account_deletion",
        "account_migration": "account_migration",
        "account_mobility": "account_mobility",
        "sub_org_creation": "sub_org_creation"
      },
      "managed_by": "managed_by"
    },
    "name": "name",
    "parent": {
      "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
      "name": "name"
    },
    "profile": {
      "business_address": "business_address",
      "business_email": "business_email",
      "business_name": "business_name",
      "business_phone": "business_phone",
      "external_metadata": "external_metadata"
    }
  },
  "success": true
}

Modify Organization -> Envelope<

Organization

put/organizations/{organization_id}

Modify organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Delete Organization -> Envelope<{ id }>

delete/organizations/{organization_id}

Delete an organization. The organization MUST be empty before deleting. It must not contain any sub-organizations, accounts, members or users. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Domain types

Organization = { id, create_time, meta, 3 more... }

References an Organization in the Cloudflare data model.

Organizations

Members

organizations.members

Methods

List Organization Members -> SinglePage<

OrganizationMember

get/organizations/{organization_id}/members

List memberships for an Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Get Organization Member -> Envelope<

OrganizationMember

get/organizations/{organization_id}/members/{member_id}

Retrieve a single membership from an Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Create Organization Member -> Envelope<

OrganizationMember

post/organizations/{organization_id}/members

Create a membership that grants access to a specific Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Delete Organization Member ->

delete/organizations/{organization_id}/members/{member_id}

Delete a membership to a particular Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Domain types

OrganizationMember = { id, create_time, meta, 3 more... }

Organizations

Organization Accounts

organizations.organization_accounts

Methods

Get Organization Accounts -> Envelope<Array<{ id, created_on, name, 2 more... }>>

get/organizations/{organization_id}/accounts

Retrieve a list of accounts that belong to a specific organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Domain types

OrganizationAccounts = { id, name, type, 3 more... }

Organizations

Organization Profile

organizations.organization_profile

Methods

Get Organization Profile -> Envelope<

AccountProfile

get/organizations/{organization_id}/profile

Get an organizations profile if it exists. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Modify Organization Profile ->

put/organizations/{organization_id}/profile

Modify organization profile. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

Domain types

OrganizationProfile = { business_address, business_email, business_name, 2 more... }