Get details about a single subscription from this user

GET/subscriptions/{name}

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

namestringrequired

`name` of the desired subscription

Responses

200Subscription found

typestringrequired

Allowed:PUBSUB

methodstringrequired

Allowed:PUSH

namestringrequired

ID of the subscription to be referenced in API calls

pathstringrequired

Path of subscription in project

topicobjectrequired

Show properties

idstringrequired

namestringrequired

pathstringrequired

ackDeadlineSecondsintegerrequired

min -9007199254740991 · max 9007199254740991

retryPolicystring | null

serviceAccountstringrequired

urlstringrequired

Publicly accessible URL that should receive the events

contactstringrequired

Email address to be contacted in case of problems with this subscription

institutionIdstringrequired

ID of the institution the current user belongs to

401Missing authentication

messagestringrequired

errorsopenApiErrorItem[]required

min items 1

Show properties

Array of openApiErrorItem

openApiErrorItem

tracestring | nullrequireddeprecated

Always null. Deprecated; may be removed in a future release.

403Invalid authorization

messagestringrequired

errorsopenApiErrorItem[]required

min items 1

Show properties

Array of openApiErrorItem

openApiErrorItem

tracestring | nullrequireddeprecated

Always null. Deprecated; may be removed in a future release.

404Subscription not found

messagestringrequired

tracestring | nullrequireddeprecated

Always null. Deprecated; may be removed in a future release.

500Internal server error

messagestringrequired

tracestring | nullrequireddeprecated

Always null. Deprecated; may be removed in a future release.

Request

curl -X GET "/subscriptions/string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/subscriptions/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "type": "PUBSUB",
  "method": "PUSH",
  "name": "de.ard.eventhub.subscription.subscription-id",
  "path": "projects/ard-eventhub/subscriptions/subscription-name",
  "topic": {
    "id": "urn:ard:permanent-livestream:topic-id",
    "name": "de.ard.eventhub.dev.urn%3Aard%3Apermanent-livestream%3Atopic-id",
    "path": "projects/ard-eventhub/topics/topic-name"
  },
  "ackDeadlineSeconds": 20,
  "retryPolicy": null,
  "serviceAccount": "name-of-service-account",
  "url": "https://example.com/my/webhook/for/this/subscription",
  "contact": "my-emergency-and-notifications-contact@ard.de",
  "institutionId": "urn:ard:institution:institution-id"
}