Skip to content

List API keys

GET
/api-keys
curl --request GET \
--url https://api.proxyrequest.com/api/v1/api-keys \
--header 'Authorization: Bearer <token>'

Returns API keys created by the authenticated account. Secret key values are returned only where the underlying account policy permits it.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

The operation completed successfully.

Media typeapplication/json
object
count
required
integer
next
string format: uri
nullable
previous
string format: uri
nullable
results
required
Array<object>
object
id
string
<= 36 characters
title
required

Descriptive label that identifies the purpose or owner of this API key. Mobile App Dashboard Integration CI Pipeline

string
<= 255 characters
prefix
required
string
key
API Key

The API key value used for authentication. Leave blank to have it generated automatically on save. Store this value securely.

string
<= 500 characters
allowed_ips
required
Array<string>
created
required
string format: date-time
updated
required
string format: date-time
Examples
Exampleexample

Example response

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"title": "Production integration",
"prefix": "prefix",
"key": "key",
"allowed_ips": [
"198.51.100.25"
],
"created": "2026-07-01T12:30:00Z",
"updated": "2026-07-01T12:30:00Z"
}
]
}

The request is malformed or violates a business rule.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
Exampleexample

Validation error

{
"non_field_errors": [
"The request could not be processed."
],
"translation": "errors.request.invalid"
}

Authentication credentials are missing, expired, or invalid.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleAuthenticationRequired

Authentication required

{
"detail": "Authentication credentials were not provided."
}

The authenticated account cannot perform this operation.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExamplePermissionDenied

Permission denied

{
"detail": "You do not have permission to perform this action."
}