A fleet API key's rotation report

GET

/api/nss/keys/{id}/rotation-report

const url = 'https://example.com/api/nss/keys/example/rotation-report?format=csv';
const options = {method: 'GET', headers: {'X-Ssoossh-Key-Secret': '<X-Ssoossh-Key-Secret>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/nss/keys/example/rotation-report?format=csv' \
  --header 'X-Ssoossh-Key-Secret: <X-Ssoossh-Key-Secret>'

Per source address, whether it has switched to the current secret since the last rotation: switched, not_switched (still presenting the previous secret, so it resolves no new accounts when the grace ends) or gone (not seen since the rotation). With format=csv the rows come as a CSV download instead. Whoever may view the key.

Authorizations

sessionCookie

Parameters

Path Parameters

required

string

Key id

Query Parameters

format

string

Allowed values: csv

Csv for a CSV download

Responses

200

The report

text/csv

object

data

required

object

current_generation

required

integer

gone

required

integer

grace_days_left

required

GraceDaysLeft is whole days, rounded up, until the previous secret stops working; zero when there is none or it has ended.

integer

key_id

required

string

not_switched

required

integer

previous_expires_at

string

rotated_at

string

rows

required

Array<object>

object

bucket

required

Bucket is switched (last presented the current secret), not_switched (last presented an older one) or gone (not seen since the rotation).

string

Allowed values: switched not_switched gone

first_seen

required

string

last_generation

required

integer

last_seen

required

string

lookups

required

integer

source_ip

required

string

switched

required

integer

error

string

400

An unknown format

text/csv

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

Example

certificate request "9f1c…" not found

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

not_found

401

No valid session

text/csv

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

Example

certificate request "9f1c…" not found

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

not_found

404

No such key the caller may view, or nss_disabled

text/csv

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

Example

certificate request "9f1c…" not found

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

not_found