[Experimental]

Update service

⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Updates the display name, logical id, or branch of a service. logicalId cannot be combined with branchId or branchGitName in one request; move the service first, then set its logicalId.

patch/v1/services/{serviceId}

Request

  • Base URL: https://api.prisma.io
  • URL: https://api.prisma.io/v1/services/{serviceId}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://auth.prisma.io/authorize, token URL https://auth.prisma.io/token, scopes: workspace:admin, offline_access)
    • HTTP bearer

Path parameters

serviceIdstring required

Request body

displayNamestring
logicalIdstring nullable

Declared identity of the resource, unique within its branch. Set by the tool that declares the resource. Send null to clear the logical id.

branchIdstring nullable
branchGitNamestring nullable

Response

Service updated.

Changes

No recorded changes to this operation across all 1 revision of this API.