Get an object

Gets a repository object by type and ID.

Path Params
string
required

Enum These are the available types for mPulse.

integer
required

This gets details for a specific object.

Headers
string

Alternative authorization methods. Options are Basic authentication or Bearer using the API Key listed in Account Settings. See Get started for help initially running the API.

string
required

All calls to this API require that you pass in the token you get from the Generate a token operation as an X-Auth-Token request header. See Get started for help to initially call the API.

string

Optional, for use with the X-Auth-Token authorization header. The name of the tenant to connect to. Must be a tenant the user account has access to.

Responses

Response body
object
attributes
array of objects
required

Type-specific attributes (required for some object types). For example, the user type includes the attributes fullName, emailAddress, and password. Different types have different sets of attributes.

attributes*
object
string

Object attribute name.

string

Object attribute value.

string
required

The XML body, required for all object types. You can get the XML body from an existing object by exporting it from the mPulse UI.

string
required

Object creation date.

boolean
required

Whether or not the object has been deleted.

effectivePermissions
object
required

Effective permissions of the user on the object.

boolean

Whether or not the user has full control over the object.

boolean

Whether or not the object can be read.

boolean

Whether or not the object can be used.

boolean

Whether or not the object can be written.

boolean
required

Whether or not the object is hidden.

integer
required

The unique ID of the newly created object.

date-time
required

Last modified date.

string
required
Defaults to akamai.com

The object name.

integer
required

Owner object ID.

boolean
required

Whether or not the object is read-only.

references
array of objects
required

Reference object data.

references*
object
boolean

Whether or not this is an embedded reference.

number

Reference ID.

string

Reference internal ID.

string

Reference name.

string | null

Reference path.

string

Reference type.

integer
required

The mPulse repository schema version.

integer
required

Tenant ID.

string
required
Defaults to domain

The mPulse object type.

alert dashboard domain tenant user

404

Not found. The requested object doesn't exist.

Language
Authentication