Method: admin.projects.locations.subscriptions.get

Returns the subscription configuration.

HTTP request

GET https://{endpoint}/v1/admin/{name=projects/*/locations/*/subscriptions/*}

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters



Required. The name of the subscription whose configuration to return.

Authorization requires the following IAM permission on the specified resource name:

  • pubsublite.subscriptions.get

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Subscription.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.