Activity Log Service API (v1)

Download OpenAPI specification:Download

Note:

Starting from March 15, 2024, authorization via Basic Auth will be discontinued for users with 2-Factor Authentication enabled.

For users:

With 2-Factor Authentication disabled for their accounts, we recommend users to enable 2-FA to improve security.
With 2-Factor Authentication enabled for their accounts, we recommend requesting token authorization through the Token Manager in the Data Center Designer (DCD). The Token Manager allows users to create, list, and delete tokens based on the defined Time To Live (TTL). This transition ensures a secure and hassle-free authorization process for enhanced account security.
IONOS' APIs and SDKs support users to authenticate using Basic Authentication which will be available until the end of this year.

For the Token management APIs, if you have:

2-Factor Authentication enabled, then you are no longer allowed to create or delete tokens using this API. You can use the Token Manager in the Data Center Designer (DCD) to create or delete tokens.

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

Responses

Response samples

200

Content type

application/json

{"href": "http://example.com",
"name": "CLOUD API",
"version": "1.0"
}

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:

NoneToken_Authentication

Responses

Response samples

200

Content type

application/json

[{"id": "contractId0",
"type": "contracts",
"href": "https://api.ionos.com/activitylog/v1/contracts/contractId0"
},
{"id": "contractId1",
"type": "contracts",
"href": "https://api.ionos.com/activitylog/v1/contracts/contractId1"
},
{"id": "contractId2",
"type": "contracts",
"href": "https://api.ionos.com/activitylog/v1/contracts/contractId2"
}
]

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:

NoneToken_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

200

Content type

application/json

{"hits": {"total": "2,",
"hits": [{"_source": {"principal": {"sourceIp": "IP_ADDRESS",
"identity": {"contractNumber": 31721060,
"username": "username@domain.tld"
},
"sourceService": "UserWebservice"
}
},
"meta": {"auditVersion": 0.1,
"time": "2016-09-23T12:02:52.394Z"
},
"event": {"param": { },
"resources": [{"action": ["sec.user.create"
],
"id": 1466,
"type": "user"
}
],
"type": "RequestAccepted"
}
}
]
}
}