Api keys

get

/team/:teamid/keys/ (authenticated)

Get active api keys

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. api_key_management
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on

delete

/team/:teamid/key/:keyid (authenticated)

Delete/revoke an API key

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. api_key_management
Accepted Restful Arguments

teamid: The id of the team to act on
keyid: undocumented

post

/team/:teamid/keys/generate (authenticated)

Generate a new API key

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. api_key_management
Accepted Body Arguments

{
// The group
group: number,
// The name of the key
name: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on

post

/team/:teamid/key/:keyid (authenticated)

Update an API key

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. api_key_management
Accepted Body Arguments

{
// The new group id
group: number,
// The new name
name: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
keyid: undocumented

Did you find what you were looking for? Thank you! There was a problem submitting your feedback. Please try again later.