Skip to content

List what an API key did

GET
/api/v1/api-keys/{id}/activity
curl --request GET \
--url https://api.deploybase.eu/api/v1/api/v1/api-keys/example/activity \
--header 'Authorization: <Authorization>'

Returns one of the current team’s API keys’ requests, newest first, 50 per page, from the audit log, which keeps 90 days. Refused and failed requests are included. Each event carries a ready-made lowercase phrase (“created a deployment of {project}”, or “tried to …” when outcome is refused or failed); {project} appears in the phrase only when project is non-null, and is where its name goes. path is the route pattern, never a concrete URL. client is the client the request claimed (unverified). Pass next_cursor back as cursor for older events; it is null on the last page. Requires the member role.

id
required
string

API key ID (UUID)

cursor
string

Next_cursor from the previous page

OK

Media type application/json
object
data
meta
object
request_id
string
timestamp
string
trace_id
string
data
object
events

Events are newest first; never null.

Array<object>
object
client

Client is the client the request claimed to come from (unverified); null when it named none.

string
Allowed values: dashboard cli mcp migrate
created_at

CreatedAt is when the request was made, in UTC.

string
id
string
method
string
outcome

Outcome is “done” below 400, “refused” for 4xx and “failed” for 5xx.

string
Allowed values: done refused failed
path

Path is the route pattern (“/api/v1/projects/:id”), never a concrete URL. Empty when the stored path is not a known pattern.

string
phrase

Phrase is lowercase-first plain English: “created a deployment of {project}”, or “tried to create a deployment of {project}” when the request was refused or failed. It holds “{project}” if and only if project is non-null; render the name there.

string
project

Project is the project the request acted on; null when unknown or deleted.

object
id
string
name
string
status_code
integer
next_cursor

NextCursor fetches the next older page as ?cursor=; null when there is none.

string

Example

{
"data": {
"events": [
{
"client": "dashboard",
"method": "POST",
"outcome": "done",
"path": "/api/v1/deployments",
"phrase": "created a deployment of {project}",
"status_code": 201
}
]
}
}

INVALID_INPUT

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

Unauthorized

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

Forbidden

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

RESOURCE_NOT_FOUND

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

Internal Server Error

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

Live 174db30c built