Spaces

List registries

Changed on

Lists all the registries.

get/spaces/{space_ref}/registries

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/spaces/{space_ref}/registries
  • Auth: none declared

Path parameters

space_refstring required

Unique path identifier for the final space in the branch. The value can be provided either as a fully URL-encoded path (e.g., organization%2Fproject) or as a plain path ending with a trailing plus sign (+) as separator (e.g., organization/project/+).

Query parameters

package_typestring[]

Registry Package Type

type'VIRTUAL' | 'UPSTREAM'

Registry Type

pageinteger

Current page number

sizeinteger

Number of items per page

sort_orderstring

sortOrder

sort_fieldstring

sortField

search_termstring

search Term.

recursiveboolean

Whether to list registries recursively.

Deprecated. Use the new scope parameter.

  • recursive=true → scope=ancestors
  • recursive=false → scope=none
scope'ancestors' | 'descendants' | 'none'

Scope of registries to list

  • none – current space only (default) * ancestors – current space plus all parent spaces * descendants – current space plus all child spaces
    If omitted, none is assumed.

Response

response for list registry

status'SUCCESS' | 'FAILURE' | 'ERROR' required

Indicates if the request was successful or not

Example response

{
  "data": {
    "pageCount": 100,
    "itemCount": 1,
    "pageSize": 1
  }
}

Changes

  • e315ed26a2f1Revision changes
    • breaking

      removed the required property /// from the response with the status

  • 81ebfef36eedRevision changes
    • info

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

    • info

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