A service enrollment's retrieval log

GET

/api/certs/requests/{id}/retrievals

const url = 'https://example.com/api/certs/requests/example/retrievals';
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/certs/requests/example/retrievals \
  --header 'X-Ssoossh-Key-Secret: <X-Ssoossh-Key-Secret>'

Redemptions of the enrollment created from this service request — when, from where, and whether a certificate was issued. Codes are reusable, so the log accumulates one row per redemption; the newest 100 are returned and “total” reports how many exist. Visible to the enrollment’s approving user and to auditors.

Authorizations

sessionCookie

Parameters

Path Parameters

required

string

The certificate request’s UUID

Responses

200

The retrieval log

application/json

object

data

required

object

retrievals

required

Array<object>

object

certificate_serial

required

A decimal string on the wire, same as CertificateResponse.SerialNumber and for the same reason.

string

retrieved_at

required

string

source_ip

required

string

succeeded

required

Succeeded is false for a redemption that passed code validation but failed at signing — still worth surfacing: someone held the code.

boolean

total

required

Total counts every logged redemption, not just the ones returned, so the UI can say what it is showing a slice of rather than implying the page is the whole history.

integer

error

string

Example

{
  "data": {
    "retrievals": [
      {
        "certificate_serial": "0"
      }
    ]
  }
}

401

No valid session

application/json

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

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

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

403

Neither the approving user nor an auditor

application/json

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

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

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

404

No enrollment for this request

application/json

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

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

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}