I/O Docs: API Documentation

• Members

  • List Methods
  • Expand Methods

  • GET fetch all /members

    Retrieves collection of Members belonging to the given Area.

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /members/:memberId

    Retrieves the identified Member.

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • POST create /members

    Creates a new Member in the given Area.

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /members/:memberId

    Updates the identified Member.

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /members/:memberId

    Deletes the identified Member. This removes the member from the area but does not delete their Mashery account.

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.

• MemberApplications

  • List Methods
  • Expand Methods

  • GET fetch all /members/:memberId/applications

    Retrieves collection of Applications belonging to the given Member belonging to the given Area.

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • PUT update /members/:memberId/applications/:applicationId

    Retrieves the identified Application.

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.
    :applicationId		string	Application identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • POST create /members/:memberId/applications

    Creates a new Application for the given Member..

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /members/:memberId/applications/:applicationId

    Deletes the identified Application.

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.
    :applicationId		string	Application identifier.

• MemberPackageKeys

  • List Methods
  • Expand Methods

  • GET fetch all /members/:memberId/packageKeys

    Retrieves collection of Package Keys belonging to the given Member belonging to the given Area.

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • PUT update /members/:memberId/applications/:applicationId/packageKeys/:packageKeyId

    Retrieves the identified Package Key

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.
    :applicationId		string	Application identifier.
    :packageKeyId		string	Key identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body

• MemberRoles

  • List Methods
  • Expand Methods

  • GET fetch all /members/:memberId/roles

    Retrieves collection of Roles assigned to the given Member belonging to the given Area.

    Parameter	Value	Type	Description
    :memberId		string	Member identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

• Applications

  • List Methods
  • Expand Methods

  • GET fetch all /applications

    Retrieves collection of Applications belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /applications/:applicationId

    Retrieves the identified Application.

    Parameter	Value	Type	Description
    :applicationId		string	Application identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • PUT update /applications/:applicationId

    Updates the identified Application.

    Parameter	Value	Type	Description
    :applicationId		string	Application identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /applications/:applicationId

    Deletes the identified Application.

    Parameter	Value	Type	Description
    :applicationId		string	Application identifier.

• ApplicationPackageKeys

  • List Methods
  • Expand Methods

  • GET fetch all /applications/:applicationId/packageKeys

    Retrieves collection of Package Keys belonging to the given Application.

    Parameter	Value	Type	Description
    :applicationId		string	Application identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • PUT update /applications/:applicationId/packageKeys/:packageKeyId

    Retrieves the identified Package Key.

    Parameter	Value	Type	Description
    :applicationId		string	Application identifier.
    :packageKeyId		string	Key identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /applications/:applicationId/packageKeys/:packageKeyId

    Deletes the identified Package Key.

    Parameter	Value	Type	Description
    :applicationId		string	Application identifier.
    :packageKeyId		string	Key identifier.

• PackageKeys

  • List Methods
  • Expand Methods

  • GET fetch all /packageKeys

    Retrieves collection of Package Keys belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /packageKeys/:packageKeyId

    Retrieves the identified Package Key.

    Parameter	Value	Type	Description
    :packageKeyId		string	Key identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • PUT update /packageKeys/:packageKeyId

    Updates the identified Package Key.

    Parameter	Value	Type	Description
    :packageKeyId		string	Key identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /packageKeys/:packageKeyId

    Deletes the identified Package Key.

    Parameter	Value	Type	Description
    :packageKeyId		string	Key identifier.

• Roles

  • List Methods
  • Expand Methods

  • GET fetch all /roles

    Retrieves collection of Roles belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /roles/:roleId

    Retrieves the identified Role.

    Parameter	Value	Type	Description
    :roleId		string	Role identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property[.property...]>[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property[.property...]>:<value>[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property[:(asc|desc)]>[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • POST create /roles

    Creates a new Role in the given Area.

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /roles/:roleId

    Updates the identified Role.

    Parameter	Value	Type	Description
    :roleId		string	Role identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /roles/:roleId

    Deletes the identified Role.

    Parameter	Value	Type	Description
    :roleId		string	Role identifier.

• Authentication

  • List Methods
  • Expand Methods

  • POST get access token /token

    Gets an access token.

    Parameter	Value	Type	Description
    grant_type		string
    username		string	The user name.
    password		string	The password.
    scope		string	The OAUTH scope.
    Authorization		string	The Authentication header.

• Services

  • List Methods
  • Expand Methods

  • GET fetch all /services

    Retrieves collection of Service Definitions belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /services/:serviceId

    Retrieves the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • POST create /services

    Creates a new Service Definition in the given Area.

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId

    Updates the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId

    Deletes the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.

• ServiceRoles

  • List Methods
  • Expand Methods

  • GET fetch all /services/:serviceId/roles

    Retrieves the identified Roles for the Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • POST create /services/:serviceId/roles

    Assigns Roles to a Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/roles

    Updates the Roles assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/roles

    Deletes the Roles assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.

• SecurityProfile

  • List Methods
  • Expand Methods

  • GET fetch /services/:serviceId/securityProfile

    Retrieves the identified Security Profile for the Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • PUT update /services/:serviceId/securityProfile

    Updates the identified Security Profile for the Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body

• OAuth

  • List Methods
  • Expand Methods

  • GET fetch /services/:serviceId/securityProfile/oauth

    Retrieves the identified Security Profile OAuth for the Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • POST create /services/:serviceId/securityProfile/oauth

    Assigns Security Profile OAuth to a Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/securityProfile/oauth

    Updates the Security Profile OAuth assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/securityProfile/oauth

    Deletes the Security Profile OAuth assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.

• ServiceCache

  • List Methods
  • Expand Methods

  • GET fetch /services/:serviceId/cache

    Retrieves the identified Cache for the Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • POST create /services/:serviceId/cache

    Assigns Cache to a Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/cache

    Updates the Cache assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/cache

    Deletes the Cache assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.

• ErrorSets

  • List Methods
  • Expand Methods

  • GET fetch all /services/:serviceId/errorSets

    Retrieves collection of ErrorSets in the identified Service Definition, returning an Array of ErrorSets

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /services/:serviceId/errorSets/:errorSetId

    Retrieves the identified ErrorSet, returning a Service Definition ErrorSet

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :errorSetId		string	Error Set identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /services/:serviceId/errorSets

    Creates a new ErrorSet in the given Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/errorSets/:errorSetId

    Updates the identified ErrorSet.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :errorSetId		string	Error Set identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/errorSets/:errorSetId

    Deletes the identified ErrorSet.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :errorSetId		string	Error Set identifier.

• ErrorMessages

  • List Methods
  • Expand Methods

  • GET fetch all /services/:serviceId/errorSets/:errorSetId/errorMessages

    Retrieves collection of ErrorMessages in the identified ErrorSet, returning an Array of ErrorMessages

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :errorSetId		string	Error Set identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /services/:serviceId/errorSets/:errorSetId/errorMessages/messageType

    Retrieves the identified ErrorMessage, returning a Service Definition ErrorMessage

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :errorSetId		string	Error Set identifier.
    messageType		string	Error Message identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • PUT update /services/:serviceId/errorSets/:errorSetId/errorMessages/messageType

    Updates the identified ErrorMessage.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :errorSetId		string	Error Set identifier.
    messageType		string	Error Message identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body

• Endpoints

  • List Methods
  • Expand Methods

  • GET fetch all /services/:serviceId/endpoints

    Retrieves collection of Endpoints in the identified Service Definition, returning an Array of Service Definition Endpoints

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /services/:serviceId/endpoints/:endpointId

    Retrieves the identified Endpoint, returning a Service Definition Endpoint

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /services/:serviceId/endpoints

    Creates a new Endpoint in the given Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/endpoints/:endpointId

    Updates the identified Endpoint.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/endpoints/:endpointId

    Deletes the identified Endpoint.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.

• ScheduledMaintenanceEvent

  • List Methods
  • Expand Methods

  • GET fetch /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent

    Retrieves the identified ScheduledMaintenanceEventEndpoint for the Service Definition Endpoint.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent

    Assigns Cache to a Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent

    Updates the ScheduledMaintenanceEventEndpoint assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent

    Deletes the ScheduledMaintenanceEventEndpoint assigned to the identified Service Definition Endpoint.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.

• EndpointCache

  • List Methods
  • Expand Methods

  • GET fetch /services/:serviceId/endpoints/:endpointId/cache

    Retrieves the identified Cache for the Endpoint Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /services/:serviceId/endpoints/:endpointId/cache

    Assigns Cache to an Endpoint Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/endpoints/:endpointId/cache

    Updates the Cache assigned to the identified Endpoint Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/endpoints/:endpointId/cache

    Deletes the Cache assigned to the identified Endpoint Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.

• Cors

  • List Methods
  • Expand Methods

  • GET fetch /services/:serviceId/endpoints/:endpointId/cors

    Retrieves the identified Cors for the Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /services/:serviceId/endpoints/:endpointId/cors

    Assigns Cors to a Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/endpoints/:endpointId/cors

    Updates the Cors assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/endpoints/:endpointId/cors

    Deletes the Cors assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.

• Roles

  • List Methods
  • Expand Methods

  • GET fetch all /roles

    Retrieves collection of Service Definitions belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

• SystemDomainAuthentication

  • List Methods
  • Expand Methods

  • GET fetch /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication

    Retrieves the identified SystemDomainAuthentication for the Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication

    Assigns SystemDomainAuthentication to a Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication

    Updates the SystemDomainAuthentication assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication

    Deletes the SystemDomainAuthentication assigned to the identified Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.

• Methods

  • List Methods
  • Expand Methods

  • GET fetch all /services/:serviceId/endpoints/:endpointId/methods

    Retrieves collection of Methods for the Endpoint in the identified Service Definition, returning an Array of Service Definition Methods

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • GET fetch /services/:serviceId/endpoints/:endpointId/methods/:methodId

    Retrieves the identified Method for the Endpoint, returning a Service Definition Method

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    :methodId		string	Method identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /services/:serviceId/endpoints/:endpointId/methods

    Creates a new Service Definition Method in the given Endpoint in the given Service Definition.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/endpoints/:endpointId/methods/:methodId

    Updates the identified Service Definition Method.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    :methodId		string	Method identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/endpoints/:endpointId/methods/:methodId

    Deletes the identified Service Definition Method.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    :methodId		string	Method identifier.

• Response Filters

  • List Methods
  • Expand Methods

  • GET fetch all /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters

    Retrieves collection of ResponseFilters for the identified Service Definition Method, returning an Array of Response Filters

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    :methodId		string	Method identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • GET fetch /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters/:responseFilterId

    Retrieves the identified Response Filter for the specified Service Definition Method

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    :methodId		string	Method identifier.
    :responseFilterId		string	Response Filter identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters

    Creates a new Method Response Filter associated with a Service Definition Method.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    :methodId		string	Method identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters/:responseFilterId

    Updates the identified Service Definition Method.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    :methodId		string	Method identifier.
    :responseFilterId		string	Response Filter identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters/:responseFilterId

    Deletes the identified Service Definition Method.

    Parameter	Value	Type	Description
    :serviceId		string	Service identifier.
    :endpointId		string	Endpoint identifier.
    :methodId		string	Method identifier.
    :responseFilterId		string	Response Filter identifier.

• Email Template Sets

  • List Methods
  • Expand Methods

  • GET fetch all /emailTemplateSets

    Retrieves collection of Email Template Sets with their respective Email Templates belonging to the given Area.

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /emailTemplateSets/:emailTemplateSetId

    Retrieves the Email Template Sets, returning a Email Template Set

    Parameter	Value	Type	Description
    :emailTemplateSetId		string	Email Template Set identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

• Email Templates

  • List Methods
  • Expand Methods

  • GET fetch all /emailTemplateSets/:emailTemplateSetId/emailTemplates

    Retrieves collection of Email Templates belonging to the given Email Template Set.

    Parameter	Value	Type	Description
    :emailTemplateSetId		string	Email Template Set identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /emailTemplateSets/:emailTemplateSetId/emailTemplates/:emailTemplateId

    Retrieves the Plan, returning a Plan

    Parameter	Value	Type	Description
    :emailTemplateSetId		string	Email Template Set identifier.
    :emailTemplateId		string	Email Template identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

• ScheduledMaintenanceEvents

  • List Methods
  • Expand Methods

  • GET fetch all /scheduledMaintenanceEvents

    Retrieves collection of all Scheduled Maintenance Events objects belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /scheduledMaintenanceEvents/:scheduledMaintenanceEventId

    Retrieves the identified Scheduled Maintenance Event.

    Parameter	Value	Type	Description
    :scheduledMaintenanceEventId		string	The Scheduled Maintenance Event identifier
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /scheduledMaintenanceEvents

    Creates a new Scheduled Maintenance Events in the given Area.

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /scheduledMaintenanceEvents/:scheduledMaintenanceEventId

    Retrieves the identified Scheduled Maintenance Event.

    Parameter	Value	Type	Description
    :scheduledMaintenanceEventId		string	The Scheduled Maintenance Event identifier
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /scheduledMaintenanceEvents/:scheduledMaintenanceEventId

    Deletes the identified Scheduled Maintenance Event.

    Parameter	Value	Type	Description
    :scheduledMaintenanceEventId		string	The Scheduled Maintenance Event identifier

• ScheduledMaintenanceEventEndpoints

  • List Methods
  • Expand Methods

  • GET fetch all /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints

    Retrieves collection of all Scheduled Maintenance Events objects belonging to the given Area

    Parameter	Value	Type	Description
    :scheduledMaintenanceEventId		string	The Scheduled Maintenance Event identifier
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints/:scheduledMaintenanceEventEndpointId

    Retrieves the identified Scheduled Maintenance Event.

    Parameter	Value	Type	Description
    :scheduledMaintenanceEventId		string	The Scheduled Maintenance Event identifier
    :scheduledMaintenanceEventEndpointId		string	The Scheduled Maintenance Event Endpoint identifier
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints

    Creates a new Scheduled Maintenance Events in the given Area.

    Parameter	Value	Type	Description
    :scheduledMaintenanceEventId		string	The Scheduled Maintenance Event identifier
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints/:scheduledMaintenanceEventEndpointId

    Deletes the identified Scheduled Maintenance Event.

    Parameter	Value	Type	Description
    :scheduledMaintenanceEventId		string	The Scheduled Maintenance Event identifier
    :scheduledMaintenanceEventEndpointId		string	The Scheduled Maintenance Event Endpoint identifier

• Domains

  • List Methods
  • Expand Methods

  • GET fetch all /domains

    Retrieves collection of all Domain Whitelist objects belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /domains/:domainId

    Retrieves the identified Domain Whitelist.

    Parameter	Value	Type	Description
    :domainId		string	DomainWhitelist indentifier. String like '859437e4-b778-49ee-8635-0afa5f021465'.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • POST create /domains

    Creates a new Domain WhiteList in the given Area.

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body

• Public Endpoint Domain Path Methods

  • List Methods
  • Expand Methods

  • GET fetch all /domains/public

    Retrieves collection of all Public Domain Endpoints belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

• System Endpoint Domain Paths

  • List Methods
  • Expand Methods

  • GET fetch all /domains/system

    Retrieves collection of all System Domain Endpoints belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

• Unique Public Fully Qualified Domain Names

  • List Methods
  • Expand Methods

  • GET fetch all /domains/public/hostnames

    Retrieves collection of all Public Domains belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

• Unique System Fully Qualified Domain Names

  • List Methods
  • Expand Methods

  • GET fetch all /domains/system/hostnames

    Retrieves collection of all System Domains belonging to the given Area

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

• Packages

  • List Methods
  • Expand Methods

  • GET fetch all /packages

    Retrieves collection of Packages with their respective Plans belonging to the given Area.

    Parameter	Value	Type	Description
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /packages/:packageId

    Retrieves the Package, returning a Package

    Parameter	Value	Type	Description
    :packageId		string	Package identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • POST create /packages

    Creates a new Package in the given area.

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /packages/:packageId

    Updates the identified Package.

    Parameter	Value	Type	Description
    :packageId		string	Package identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /packages/:packageId

    Deletes the identified Package.

    Parameter	Value	Type	Description
    :packageId		string	Package identifier.

• Plans

  • List Methods
  • Expand Methods

  • GET fetch all /packages/:packageId/plans

    Retrieves collection of Plans belonging to the given Package.

    Parameter	Value	Type	Description
    :packageId		string	Package identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.

  • GET fetch /packages/:packageId/plans/:planId

    Retrieves the Plan, returning a Plan

    Parameter	Value	Type	Description
    :packageId		string	Package identifier.
    :planId		string	Plan identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /packages/:packageId/plans

    Creates a new Plan in the given Package.

    Parameter	Value	Type	Description
    :packageId		string	Package identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • PUT update /packages/:packageId/plans/:planId

    Updates the identified Plan.

    Parameter	Value	Type	Description
    :planId		string	Plan identifier.
    Content-Type		string	Content type of the payload
    Accept		string	The content type to request from the server.

    Request Body
  • DELETE delete /packages/:packageId/plans/:planId

    Deletes the identified Plan.

    Parameter	Value	Type	Description
    :planId		string	Plan identifier.

• Plan Services

  • List Methods
  • Expand Methods

  • GET fetch all /packages/:packageId/plans/:planId/services

    Retrieves collection of Plan Services belonging to the given Plan.

    Parameter	Value	Type	Description
    :packageId		string	Package identifier.
    :planId		string	Plan identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • GET fetch /packages/:packageId/plans/:planId/services/:serviceId

    Retrieves the Plan Service, returning a Plan Service

    Parameter	Value	Type	Description
    :packageId		string	Package identifier.
    :planId		string	Plan identifier.
    :serviceId		string	Service identifier.
    fields		string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
    filter		string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
    sort		string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
    limit		int	Number of objects to return in the result. Defaults to 100.
    offset		int	0-based index of first object in the list to return. Defaults to 0.
    indent	True False	boolean	When set to true, responses are indented for better readability.

  • POST create /packages/:packageId/plans/:planId/services

    Creates a new Plan Service in the given Plan.

    Parameter	Value	Type	Description
    :packageId		string	Package identifier.
    :planId		string	Plan identifier.
    Content-Type		string	Content type of the payload