Page Comparison

Table of Contents

minLevel	2
maxLevel	2
outline	false
type	flat
separator	brackets
printable	true

...

Endpoints and methods

Anchor
getList
getList
GET `/v2/accounts/{accountName}/tokens`

Lists all the tokens for the provided account. This endpoint returns the information about the tokens and their IDs , but NOT the tokens themselves does not include the actual token values for security reasons.

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`accountName` ^required	`string`	The name of the account.

Find below a request example:

Code Block
https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens

Expand

title	Response

Code

Description

200

Successful response. List of tokens retrieved.

Code Block

[
  {
    "name": "a",
    "id": 1,
    "scope": "table://*.** level://admin",
    "owner": "web-testing+auto-admin@devo.com",
    "user": "web-testing+auto-admin@devo.com",
    "audience": "apiv2-admin aggregations apiv2",
    "token_type": "Bearer",
    "active": true,
    "expiration": "2024-11-26T14:38:18.000+0000",
    "account": "sampleAccount",
    "created": "2024-11-25T14:38:18.000+0000",
    "updated": "2024-11-25T14:38:18.000+0000",
    "expires_in_seconds": 86400
  },
  {
    "name": "b",
    "id": 2,
    "scope": "table://*.** level://admin",
    "owner": "web-testing+auto-admin@devo.com",
    "user": "web-testing+auto-admin@devo.com",
    "audience": "apiv2-admin aggregations apiv2",
    "token_type": "Bearer",
    "active": true,
    "expiration": "2024-11-26T14:38:18.000+0000",
    "account": "sampleAccount",
    "created": "2024-11-25T14:38:18.000+0000",
    "updated": "2024-11-25T14:38:18.000+0000",
    "expires_in_seconds": 86400
  }
]

4xx

Bad request.

Code Block
{ "error": { "code": 4xx, "message": "string" } }

...

Anchor
getToken
getToken
GET `/v2/accounts/{accountName}/tokens/{tokenId}`

Returns the full information on details of a single token , identified by its ID. The response to this request includes the actual token value.

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`accountName` ^required	`string`	The name of the account.
`tokenId` ^required	`string`	The ID of the token.

Find below a request example:

Code Block
https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3

...

Anchor
createToken
createToken
POST`/v2/accounts/{accountName}/tokens`

...

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`accountName` ^required	`string`	The name of the account.

Payload:

Code Block
{ "name": "string", "owner": "email", "user": "email", "audience": "string", "scopes": "string", "expiresInSeconds": 86400 }

name is optional, and defaults to 'Unnamed' when not present.
user is optional and only required when a user is creating a token on behalf of another user. The credentials are resolved for the value of this field (which defaults to the owner when not present).
audience is required (samples: apiv2, apiv2-admin, alerts, aggregations, http).
scopes is optional and defaults to 'default' when not present.
expiresInSeconds is optional and defaults to 86400 when not present. Use the value -1 to create a permanent token.

Find below a request example:

Code Block
https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens

info

Expand

title	Response

Info
Creating a token returns the `location` header with the URI where the resource can be located.

Code

Description

200

Successful response. Token created.

Code Block
{ TBD }

4xx

Bad request.

Code Block
{ "error": { "code": 4xx, "message": "string" } }

Creating a token returns the location header with the URI where the resource can be located.

...

Anchor
enableToken
enableToken
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/enable`

Enable token by ID.

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`accountName` ^required	`string`	The name of the account.
`tokenId` ^required	`string`	The ID of the token.

Find below a request example:

Code Block
https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3/enable

Expand

title	Response

Code

Description

200

Successful response. Token enabled.

4xx

Bad request.

Code Block
{ "error": { "code": 4xx, "message": "string" } }

...

Anchor
path11
path11
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/disable`

Disable token by ID.

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`accountName` ^required	`string`	The name of the account.
`tokenId` ^required	`string`	The ID of the token.

Find below a request example:

Code Block
https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3/disable

...

Anchor
renameToken
renameToken
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/rename`

Enable token by IDThis endpoint updates the name associated with a token, identified by its ID.

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`accountName` ^required	`string`	The name of the account.
`tokenId` ^required	`string`	The ID of the token.

Payload:

Code Block
{ "value": "your new token name" }

If the new name is empty or null, the service will still return OK, but the token name will remain unchanged.

Find below a request example:

Code Block
https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3/rename

...

Anchor
deleteToken
deleteToken
DELETE`/v2/accounts/{accountName}/tokens/{tokenId}`

...

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`accountName` ^required	`string`	The name of the account.
`tokenId` ^required	`string`	The ID of the token.

Find below a request example:

Code Block
https://api-us.devo.com/xxx/v2/accounts/sampleAccount/tokens/3

...

Version	Old Version 8	New Version Current
Changes made by	Alvaro de la Serna Martinez	Alvaro de la Serna Martinez
Saved on	Dec 18, 2024	Dec 20, 2024

Versions Compared

Key

Endpoints and methods

Anchor
getList
getList
GET `/v2/accounts/{accountName}/tokens`

Path parameters

Anchor
getToken
getToken
GET `/v2/accounts/{accountName}/tokens/{tokenId}`

Path parameters

Anchor
createToken
createToken
POST`/v2/accounts/{accountName}/tokens`

Path parameters

Anchor
enableToken
enableToken
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/enable`

Path parameters

Anchor
path11
path11
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/disable`

Path parameters

Anchor
renameToken
renameToken
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/rename`

Path parameters

Anchor
deleteToken
deleteToken
DELETE`/v2/accounts/{accountName}/tokens/{tokenId}`

Path parameters

Page Comparison

Versions Compared

Key

Endpoints and methods

AnchorgetListgetList GET /v2/accounts/{accountName}/tokens

Path parameters

AnchorgetTokengetToken GET /v2/accounts/{accountName}/tokens/{tokenId}

Path parameters

AnchorcreateTokencreateToken POST/v2/accounts/{accountName}/tokens

Path parameters

AnchorenableTokenenableToken PUT/v2/accounts/{accountName}/tokens/{tokenId}/enable

Path parameters

Anchorpath11path11 PUT/v2/accounts/{accountName}/tokens/{tokenId}/disable

Path parameters

AnchorrenameTokenrenameToken PUT/v2/accounts/{accountName}/tokens/{tokenId}/rename

Path parameters

AnchordeleteTokendeleteToken DELETE/v2/accounts/{accountName}/tokens/{tokenId}

Path parameters

Anchor
getList
getList
GET `/v2/accounts/{accountName}/tokens`

Anchor
getToken
getToken
GET `/v2/accounts/{accountName}/tokens/{tokenId}`

Anchor
createToken
createToken
POST`/v2/accounts/{accountName}/tokens`

Anchor
enableToken
enableToken
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/enable`

Anchor
path11
path11
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/disable`

Anchor
renameToken
renameToken
PUT`/v2/accounts/{accountName}/tokens/{tokenId}/rename`

Anchor
deleteToken
deleteToken
DELETE`/v2/accounts/{accountName}/tokens/{tokenId}`