Activity Log Service API (v1)

Download OpenAPI specification:Download

The Activity Log API allows contract owners and administrators to discover what activity has happened under a specific contract. This allows auditing of user activities as well as changes to any resources. The activity is grouped by contract and can be refined using date ranges. Activity information is READ-ONLY so all calls made against the Activity Log API will be handled using GET requests.

Info

Display API information

Display API information

Responses

Response samples

Content type
application/json
{}

Contracts

List all accessible contracts

This operation is retrieving a list of contracts that your account credentials are authorized to access. This operation is primarily useful to IONOS' Resellers, as a non-reseller user account will only have access to a single contract.

Authorizations:
Basic_AuthenticationToken_Authentication

Responses

Response samples

Content type
application/json
[]

Download Activity Log entries.

This operation returns the actual activity log data related to the specific contractId supplied in the request. The amount of data returned can be limited by providing one or both of the optional startDate and endDate parameters.

If valid values for both dateStart and dateEnd are supplied, then the activity log information for the date range specified will be returned. Omitting either dateStart or dateEnd will return all entries available after dateStart or before dateEnd.

For pagination use the page and size parameters.

Authorizations:
Basic_AuthenticationToken_Authentication
path Parameters
contractNumber
required
integer

Contract number thats activity log entires should be downloaded.

query Parameters
dateStart
string

Start date for the Activity Log entries (inclusive) (e.g. '2021-09-23T11:43:51Z' or '2016-07-01')

dateEnd
string

End date for the Activity Log entries (exclusive) (e.g. '2021-09-27T10:31:15Z' or '2016-07-30')

offset
integer
Default: 0

Page index ( the number of hits to skip )

limit
integer
Default: 20

Page size ( the maximum number of hits to return )

Responses

Response samples

Content type
application/json
{
  • "hits": {
    }
}