POpolytomic
Harbors

List Harbor Contexts

Changed on

Lists context document metadata for a Harbor without returning document content.

Collection items include the current published version number and omit content. Use the context item endpoint to retrieve a complete document.

A Harbor profile credential can read context only when harbor_id identifies its own Harbor.

get/api/harbors/{harbor_id}/contexts

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

harbor_idstring uuid required

Unique identifier of the Harbor

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Query parameters

limitinteger

Maximum number of context documents to return. Defaults to 50 and cannot exceed 50.

Example:50
page_tokenstring

Opaque pagination cursor returned by the previous request

Headers

X-Polytomic-Versionstring
X-Polytomic-Harbor-Sessionstring

Harbor session token; when supplied, the session must be active and bound to this credential and Harbor.

X-Polytomic-Activity-Request-IDstring

New nonzero UUID for each request, required for scoped credentials; a reused value is rejected.

Response

OK

Example response

{
  "data": [
    {
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "revision_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
    }
  ],
  "pagination": {
    "next_page_token": "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K=="
  }
}

Changes

  • d80b0fdea14eRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

  • 30ade6c6d535Revision changes
    • info

      added the new optional header request parameter X-Polytomic-Activity-Request-ID

    • info

      added the new optional header request parameter X-Polytomic-Harbor-Session

    • info

      added the optional property // to the response with the status