Overview
Error Handling

Methods

API Documentation (API Version bleed)

Network/CDN/User/

DESCRIPTION

create

URL:

https://api.liquidweb.com/bleed/Network/CDN/User/create

Description:

Adds a CDN user for account.

In order to add a user account, the user creating the account *must* agree to the CF terms of service by passing "accept_terms => 1" through. https://www.cloudflare.com/terms/

Parameters:

ParameterTypeNotes
accept_termsThe value: '1'* Required
emailA valid email address.* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
emailA valid email address.
idA positive integer value (i.e. 1 and up).
remoteUserLookupAn associative array of arbitrary keys and values.* Optional
unique_idA string of text, containing no newlines or other control characters.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.liquidweb.com/bleed/Network/CDN/User/details

Description:

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
emailA valid email address.* Required if:
  • id is not given
idA valid id number (a positive integer).* Required if:
  • email is not given

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
client_api_keyA string of text, containing no newlines or other control characters.* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
emailA valid email address.
idA positive integer value (i.e. 1 and up).
remoteUserLookupAn associative array of arbitrary keys and values.* Optional
unique_idA string of text, containing no newlines or other control characters.
user_keyA string of text, containing no newlines or other control characters.* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.liquidweb.com/bleed/Network/CDN/User/list

Description:

Parameters:

ParameterTypeNotes
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
accntA valid account number, up to 6 digits in length.
client_api_keyA string of text, containing no newlines or other control characters.* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
emailA valid email address.
idA positive integer value (i.e. 1 and up).
remoteUserLookupAn associative array of arbitrary keys and values.* Optional
unique_idA string of text, containing no newlines or other control characters.
user_keyA string of text, containing no newlines or other control characters.* Optional
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

sendEmail

URL:

https://api.liquidweb.com/bleed/Network/CDN/User/sendEmail

Description:

Send an activation email to the email address associated with the CDN user, or to another specified address.

Parameters:

ParameterTypeNotes
administrator

A boolean value (0 or 1).

True if you want this email address to have administrator access in the remote interface

* Optional
  • Defaults to: 1
billing

A boolean value (0 or 1).

True if you want this email address to have billing access in the remote interface

* Optional
  • Defaults to: 1
emailA valid email address.
idA valid id number (a positive integer).* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types