Client Reference
Accounts
Accounts endpoint reference.
List
List all accounts you have ownership or verified access to.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
params | array | No | [] | Array containing the necessary params. |
php
$response = $client->accounts()->list([]);
Create
Create an account (only available for tenant admins at this time)
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | Account name | |
type | string | Yes | The type of account being created. For self-serve customers, use standard. for enterprise customers, use enterprise. | |
unit | string|null | No | Tenant unit ID. Information related to the tenant unit, and optionally, an id of the unit to create the account on. [see](https://developers.cloudflare.com/tenant/how-to/manage-accounts/) |
php
$response = $client->accounts()->create('NAME', 'TYPE', 'UNIT');
Get
Get information about a specific account that you are a member of.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. |
php
$response = $client->accounts()->get('ACCOUNT_ID');
Update
Update an existing account.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
name | string | Yes | Account name. | |
settings | array | No | [] | Account settings. |
php
$response = $client->accounts()->update('ACCOUNT_ID', 'NAME', []);
Delete
Delete a specific account (only available for tenant admins at this time). This is a permanent operation that will delete any zones or other resources under the account
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes |
php
$response = $client->accounts()->delete('ACCOUNT_ID');
Profile
Get account profile.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. |
php
$response = $client->accounts()->profile('ACCOUNT_ID');
Update Profile
Modify account profile.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. | |
values | array | No | [] | Account profile values. |
php
$response = $client->accounts()->updateProfile('ACCOUNT_ID', []);
Organizations
List account organizations.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account identifier. |
php
$response = $client->accounts()->organizations('ACCOUNT_ID');