Get keyset by ID

Retrieves a single keyset by its ID.

Path Parameters
id string — REQUIRED
Header Parameters
PubNub-Version string — REQUIRED

Possible values: [2025-11-01]

Responses
200

Success

Schema — OPTIONAL
name string

A human-readable name for the keyset.

appId string

The ID of the app this this keyset belongs to.

type string

Possible values: [testing, production]

The type of the keyset, either "testing" or "production. Testing keysets are used for development and testing purposes and can be affected with stronger rate limits. Creating a production keyset requires a paid plan, visit Admin Portal to upgrade.

id string
publishKey string
subscribeKey string
createdAt string — OPTIONAL
updatedAt string — OPTIONAL
400

Bad Request Error

Schema — OPTIONAL
statusCode number
error string

Possible values: [BadRequest]

message string[]
401

UnauthorizedError

Schema — OPTIONAL
statusCode number
error string

Possible values: [Unauthorized]

message string[]
403

ForbiddenError

Schema — OPTIONAL
statusCode number
error string

Possible values: [Forbidden]

message string[]
500

InternalErrorError

Schema — OPTIONAL
statusCode number
error string

Possible values: [InternalError]

message string[]
* required
PubNub-Version*
Type: string
Possible values: [2025-11-01]
* required
id*
Type: string
name
Type: string
A human-readable name for the keyset.
appId
Type: string
The ID of the app this this keyset belongs to.
type
Type: string
The type of the keyset, either "testing" or "production. Testing keysets are used for development and testing purposes and can be affected with stronger rate limits. Creating a production keyset requires a paid plan, visit Admin Portal to upgrade.
Enum (2 values)
View all values
"testing""production"
id
Type: string
publishKey
Type: string
subscribeKey
Type: string
createdAt
Type: string
updatedAt
Type: string
statusCode
Type: number
error
Type: string
Enum (1 values)
View all values
"BadRequest"
message
Type: array
Array items:
items
Type: string
statusCode
Type: number
error
Type: string
Enum (1 values)
View all values
"Unauthorized"
message
Type: array
Array items:
items
Type: string
statusCode
Type: number
error
Type: string
Enum (1 values)
View all values
"Forbidden"
message
Type: array
Array items:
items
Type: string
statusCode
Type: number
error
Type: string
Enum (1 values)
View all values
"InternalError"
message
Type: array
Array items:
items
Type: string