Get audit history

get https://{hostname}/papi/v1/hostnames/{hostname}/audit-history

Gets a detailed record of all modifications made to a property hostname.

Recipes

Get audit history for property hostnames

Open Recipe

Responses

Response body

object

history

object

The set of requested property hostname data, available within an items array.

items

array of objects

Each entry specifies a change to the requested property hostname with details about the user who made that modification and the time it happened. Relevant response objects appear in a descending chronological order within the outer envelope's history.items array.

items

object

action

string

required

The type of action performed to the property hostname, either:

ACTIVATE if the hostname is currently serving traffic,
DEACTIVATE if the hostname isn't serving traffic,
ADD if the user requested to add the hostname to a property,
REMOVE if the user requested to remove the hostname from a property,
MOVE if the hostname was moved from one property to another,
MODIFY if the user changed the edgeHostnameId or certProvisioningType values for an already-activated hostname,
ABORTED when the user request to cancel the hostname activation,
ERROR if the hostname activation failed.

ADD ACTIVATE REMOVE DEACTIVATE MOVE MODIFY ABORTED ERROR

certProvisioningType

string

required

Indicates the type of the certificate used in the property hostname. Either CPS_MANAGED for the certificates you create with the Certificate Provisioning System API (CPS), or DEFAULT for Default Domain Validation (DV) certificates deployed automatically. Note that you can't specify the DEFAULT value if your account hostname uses the akamaized.net domain suffix.

CPS_MANAGED DEFAULT

cnameTo

string

The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's edgeHostnameDomain member.

contractId

string

required

Identifies the prevailing contract under which you requested the data. See ID prefixes for details on how to omit the ID's ctr_ prefix.

edgeHostnameId

string

required

Identifies the edge hostname you mapped your traffic to. See ID prefixes for details on how to omit the ID's ehn_ prefix.

groupId

string

required

Identifies the group under which the property activated. See ID prefixes for details on how to omit the ID's grp_ prefix.

network

string

The network of activated hostnames, either STAGING or PRODUCTION.

STAGING PRODUCTION

propertyId

string

required

Unique identifier for the property. See ID prefixes for details on how to omit the ID's prp_ prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See Manage properties and includes.

timestamp

string

required

Indicates when the action occurred.

user

string

required

The user who initiated the action.

hostname

string

The cnameFrom for the hostname your end users see, indicated by the Host header in end user requests.

Headers

object

X-RateLimit-Limit

integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

X-RateLimit-Remaining

integer

Remianing number of requests allowed each minute per account. See Rate and resource limiting for details.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/papi/v1/hostnames/hostname/audit-history \
3
     --header 'PAPI-Use-Prefixes: true' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200The response shows the audit history for the requested property hostname. The response includes information when the property hostname was first created and activated, might also show other changes if the item was later edited.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.