Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
gpg_keys
GPG Keys

List GPG Keys

List GPG Keys

get/gpg_keys

Query parameters

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, name or expires_at.

If set, return records where the specified field is equal to the supplied value. Valid fields are workspace_id, partner_id or expires_at.

If set, return records where the specified field is greater than the supplied value. Valid fields are expires_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are expires_at.

If set, return records where the specified field is less than the supplied value. Valid fields are expires_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are expires_at.

Response

A list of GpgKeys objects.

idinteger

GPG key ID.

workspace_idinteger

Workspace ID (0 for default workspace).

expires_atstring date-time

GPG key expiration date.

namestring

GPG key name.

partner_idinteger

Partner ID who owns this GPG Key, if applicable.

partner_namestring

Name of the Partner who owns this GPG Key, if applicable.

user_idinteger

User ID who owns this GPG Key, if applicable.

public_key_md5string

MD5 hash of the GPG public key

private_key_md5string

MD5 hash of the GPG private key.

generated_public_keystring

GPG public key

generated_private_keystring

GPG private key.

private_key_password_md5string

GPG private key password. Only required for password protected keys.

Example response

[
  {
    "id": 1,
    "expires_at": "2000-01-01T01:00:00Z",
    "name": "key name",
    "partner_id": 1,
    "partner_name": "example",
    "user_id": 1,
    "public_key_md5": "7f8bc1210b09b9ddf469e6b6b8920e76",
    "private_key_md5": "ab236cfe4a195f0226bc2e674afdd6b0",
    "generated_public_key": "7f8bc1210b09b9ddf469e6b6b8920e76",
    "generated_private_key": "ab236cfe4a195f0226bc2e674afdd6b0",
    "private_key_password_md5": "[the GPG private key password]"
  }
]