/v1/services

GET

/v1/services

curl --request GET \
  --url https://example.com/v1/services

Exact unranked search. The encoded query is limited to 65536 bytes and all decoded values share one aggregate limit of 4876 Unicode scalar values. Individual field maxima do not imply that their aggregate is accepted.

Parameters

Query Parameters

recordId

Array<string>

>= 1 items <= 100 items

Repeated exact-match values sharing the operation-wide aggregate limit of 4876 decoded Unicode scalar values.

serviceId

Array<string>

>= 1 items <= 100 items

Repeated exact-match values sharing the operation-wide aggregate limit of 4876 decoded Unicode scalar values.

serviceKind

Array<string>

>= 1 items <= 1 items unique items

Allowed values: evidence

Repeated exact-match values sharing the operation-wide aggregate limit of 4876 decoded Unicode scalar values.

jurisdiction

Array<string>

>= 1 items <= 100 items

Repeated exact-match values sharing the operation-wide aggregate limit of 4876 decoded Unicode scalar values.

conformsTo

Array<string>

>= 1 items <= 100 items

Repeated exact-match values sharing the operation-wide aggregate limit of 4876 decoded Unicode scalar values.

evidenceType

Array<string>

>= 1 items <= 100 items

Repeated exact-match values sharing the operation-wide aggregate limit of 4876 decoded Unicode scalar values.

Responses

200

Complete exact search result

Media typeapplication/json

object

catalogRevision

required

string

>= 71 characters <= 71 characters /^sha256:[0-9a-f]{64}$/

items

required

Array<object>

0 <= 10000 items

object

bindingId

required

string format: uri

>= 1 characters <= 4096 characters /^[A-Za-z][A-Za-z0-9+.-]*:/

conformsTo

required

Array<string>

>= 1 items <= 256 items unique items

description

required

string

>= 1 characters <= 16384 characters /^[^\u0000-\u001f\u007f-\u009f]+$/

endpointUrl

required

string format: uri

>= 1 characters <= 4096 characters /^(?:https://[^\s\u0000-\u001f\u007f-\u009f/?#@]+|http://(?:localhost|127\.0\.0\.1|\[::1\])(?::[0-9]+)?)(?!.*//)(?:/[^\s\u0000-\u001f\u007f-\u009f?#]*)?$/

evidenceTypeIds

required

Array<string>

0 <= 256 items unique items

jurisdictions

required

Array<string>

>= 1 items <= 256 items unique items

legalIssuerId

string format: uri

>= 1 characters <= 4096 characters /^[A-Za-z][A-Za-z0-9+.-]*:/

operationFamilyIds

required

Array<string>

0 0 unique items

operatorId

string format: uri

>= 1 characters <= 4096 characters /^[A-Za-z][A-Za-z0-9+.-]*:/

originContentDigest

required

string

>= 71 characters <= 71 characters /^sha256:[0-9a-f]{64}$/

originFetchedAt

required

string format: date-time

<= 64 characters

originId

required

string

>= 1 characters <= 4096 characters /^[^\s\u0000-\u001f\u007f](?:[^\u0000-\u001f\u007f]*[^\s\u0000-\u001f\u007f])?$/

originUrl

required

string format: uri

>= 1 characters <= 4096 characters /^(?:https://[^\s\u0000-\u001f\u007f-\u009f/?#@]+|http://(?:localhost|127\.0\.0\.1|\[::1\])(?::[0-9]+)?)(?!.*//)(?:/[^\s\u0000-\u001f\u007f-\u009f?#]*)?$/

publisherId

string format: uri

>= 1 characters <= 4096 characters /^[A-Za-z][A-Za-z0-9+.-]*:/

recordId

required

string

>= 1 characters <= 4096 characters /^[^\s\u0000-\u001f\u007f](?:[^\u0000-\u001f\u007f]*[^\s\u0000-\u001f\u007f])?$/

registryAuthorityId

string format: uri

>= 1 characters <= 4096 characters /^[A-Za-z][A-Za-z0-9+.-]*:/

semanticClassIds

required

Array<string>

0 0 unique items

serviceId

required

string format: uri

>= 1 characters <= 4096 characters /^[A-Za-z][A-Za-z0-9+.-]*:/

serviceKind

required

string

Allowed values: evidence

technicalProviderId

string format: uri

>= 1 characters <= 4096 characters /^[A-Za-z][A-Za-z0-9+.-]*:/

title

required

string

>= 1 characters <= 16384 characters /^[^\u0000-\u001f\u007f-\u009f]+$/

Example

{
  "items": [
    {
      "serviceKind": "evidence"
    }
  ]
}

400

Invalid request or request body exceeds the configured bound

Media typeapplication/problem+json

One of:

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.invalid

detail

required

string

<= 1024 characters

Allowed value: The Discovery request is invalid.

status

required

integer

Allowed value: 400

title

required

string

Allowed value: Invalid request

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/invalid-request

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.not-found

detail

required

string

<= 1024 characters

Allowed value: The requested Discovery resource was not found.

status

required

integer

Allowed value: 404

title

required

string

Allowed value: Not found

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/not-found

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.result-bound-exceeded

detail

required

string

<= 1024 characters

Allowed value: The complete Discovery result exceeds its configured bound.

status

required

integer

Allowed value: 422

title

required

string

Allowed value: Result bound exceeded

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/result-bound-exceeded

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: service.unavailable

detail

required

string

<= 1024 characters

Allowed value: Registry Discovery is temporarily unavailable.

status

required

integer

Allowed value: 503

title

required

string

Allowed value: Unavailable

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/unavailable

Example

{
  "code": "request.invalid",
  "detail": "The Discovery request is invalid.",
  "status": 400,
  "title": "Invalid request",
  "type": "https://id.registrystack.org/problems/registry-discovery/invalid-request"
}

Headers

traceparent

required

string

>= 55 characters <= 55 characters /^00-(?!0{32}-)[0-9a-f]{32}-(?!0{16}-)[0-9a-f]{16}-[0-9a-f]{2}$/

Canonical W3C Trace Context version 0; the trace identifier equals the problem traceId.

422

Complete result exceeds the configured bound

Media typeapplication/problem+json

One of:

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.invalid

detail

required

string

<= 1024 characters

Allowed value: The Discovery request is invalid.

status

required

integer

Allowed value: 400

title

required

string

Allowed value: Invalid request

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/invalid-request

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.not-found

detail

required

string

<= 1024 characters

Allowed value: The requested Discovery resource was not found.

status

required

integer

Allowed value: 404

title

required

string

Allowed value: Not found

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/not-found

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.result-bound-exceeded

detail

required

string

<= 1024 characters

Allowed value: The complete Discovery result exceeds its configured bound.

status

required

integer

Allowed value: 422

title

required

string

Allowed value: Result bound exceeded

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/result-bound-exceeded

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: service.unavailable

detail

required

string

<= 1024 characters

Allowed value: Registry Discovery is temporarily unavailable.

status

required

integer

Allowed value: 503

title

required

string

Allowed value: Unavailable

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/unavailable

Example

{
  "code": "request.invalid",
  "detail": "The Discovery request is invalid.",
  "status": 400,
  "title": "Invalid request",
  "type": "https://id.registrystack.org/problems/registry-discovery/invalid-request"
}

Headers

traceparent

required

string

>= 55 characters <= 55 characters /^00-(?!0{32}-)[0-9a-f]{32}-(?!0{16}-)[0-9a-f]{16}-[0-9a-f]{2}$/

Canonical W3C Trace Context version 0; the trace identifier equals the problem traceId.

503

Request exceeded the configured time limit or the response could not be produced

Media typeapplication/problem+json

One of:

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.invalid

detail

required

string

<= 1024 characters

Allowed value: The Discovery request is invalid.

status

required

integer

Allowed value: 400

title

required

string

Allowed value: Invalid request

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/invalid-request

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.not-found

detail

required

string

<= 1024 characters

Allowed value: The requested Discovery resource was not found.

status

required

integer

Allowed value: 404

title

required

string

Allowed value: Not found

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/not-found

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.result-bound-exceeded

detail

required

string

<= 1024 characters

Allowed value: The complete Discovery result exceeds its configured bound.

status

required

integer

Allowed value: 422

title

required

string

Allowed value: Result bound exceeded

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/result-bound-exceeded

object

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: service.unavailable

detail

required

string

<= 1024 characters

Allowed value: Registry Discovery is temporarily unavailable.

status

required

integer

Allowed value: 503

title

required

string

Allowed value: Unavailable

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/unavailable

Example

{
  "code": "request.invalid",
  "detail": "The Discovery request is invalid.",
  "status": 400,
  "title": "Invalid request",
  "type": "https://id.registrystack.org/problems/registry-discovery/invalid-request"
}

Headers

traceparent

required

string

>= 55 characters <= 55 characters /^00-(?!0{32}-)[0-9a-f]{32}-(?!0{16}-)[0-9a-f]{16}-[0-9a-f]{2}$/

Canonical W3C Trace Context version 0; the trace identifier equals the problem traceId.