Auth API (1.0)

Use the Auth API to manage tokens for secure access to IONOS Cloud APIs (Auth API, Cloud API, Reseller API, Activity Log API, and others).

swagger 2 Source url

Authentication

Basic Authentication

You will need to base64 encode the string containing your credentials. Separate your username and password with a colon, i.e., username:password and send it as 'Authorization' request header. More details: https://en.wikipedia.org/wiki/Basic_access_authentication

API key

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.


tokens

Create new tokens

Users can generate new tokens (JWT or JSON Web Token). By default, new tokens are linked to the user’s contract. Users with multiple contracts must provide the contract number, for which the token is generated, in the X-Contract-Number header; otherwise, an error response is returned.


To access this endpoint, 'Basic Authentication' or 'Token Authentication' tokens with valid credentials must be encapsulated in the header, by users with one or with multiple contracts.


The response will contain a newly-generated token for accessing any IONOS Cloud APIs (Auth API, Cloud API, Reseller API, Activity Log API, and others). The token can be used to access the APIs without providing the contract number in the X-Contract-Number header, by users with one or with multiple contracts. However, a valid contract number must be provided in the X-Contract-Number header to access the Auth API. By default, generated access tokens will expire after one year (subject to change).


get https://api.ionos.com/auth/v1 /tokens/generate Try out

List all tokens

List the details of all tokens, generated by the user. To access this endpoint, 'Basic Authentication' or 'Token Authentication' tokens with valid credentials must be encapsulated in the header. Users with multiple contracts must also provide a valid contract number in the X-Contract-Number header.


get https://api.ionos.com/auth/v1 /tokens Try out

Delete tokens by criteria

Delete one or multiple tokens by the required criteria parameter values: ALL, EXPIRED and CURRENT. With parameter values ALL and EXPIRED, 'Basic Authentication' or 'Token Authentication' tokens with valid credentials must be encapsulated in the header. With value CURRENT, only the 'Token Authentication' with valid credentials is required. Users with multiple contracts must also provide a valid contract number in the X-Contract-Number header.


delete https://api.ionos.com/auth/v1 /tokens Try out

Get tokens by Key ID

Retrieve the details for a token by the Key ID (tokenId). To access this endpoint, 'Basic Authentication' or 'Token Authentication' tokens with valid credentials must be encapsulated in the header. Users with multiple contracts must also provide a valid contract number in the X-Contract-Number header.


get https://api.ionos.com/auth/v1 /tokens/{tokenId} Try out

Delete tokens

Delete a token by Key ID (tokenId). To access the endpoint, 'Basic Authentication' or 'Token Authentication' tokens with valid credentials must be encapsulated in the header. Users with multiple contracts must also provide a valid contract number in the X-Contract-Number header.


delete https://api.ionos.com/auth/v1 /tokens/{tokenId} Try out