Method: admin.projects.locations.subscriptions.create

Creates a new subscription.

HTTP request

POST https://{endpoint}/v1/admin/{parent=projects/*/locations/*}/subscriptions

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent location in which to create the subscription. Structured like projects/{project_number}/locations/{location}.

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

  • pubsublite.subscriptions.create

Query parameters

Parameters
subscriptionId

string

Required. The ID to use for the subscription, which will become the final component of the subscription's name.

This value is structured like: my-sub-name.

skipBacklog

boolean

If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.

Request body

The request body contains an instance of Subscription.

Response body

If successful, the response body contains a newly created instance of Subscription.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.