Skip to content
Console
On this page

Update a service enablement

Enables or disables a service on a project (`spec.enabled`).

Enables or disables a service on a project (spec.enabled).

  • Path PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/service_enablements/service-enablement
  • Scope access:admin
  • Effect write — a successful call changes state.
  • Collection service_enablements
  • Query update_mask, validate_only

Request

FieldTypeWhat it is
service_enablementServiceEnablementThe service enablement to update; name identifies it. Required.
update_maskfield_maskThe fields to write; unset writes every populated field.
validate_onlyboolValidate and return the result without writing anything.

ServiceEnablement

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/service_enablements/{service}.
metaResourceMetaResource metadata.
specServiceEnablementSpecDesired state. Required.

ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

ServiceEnablementSpec

FieldTypeWhat it is
enabledboolWhether the project's keys may reach the service. Required.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/service_enablements/{service}.
uidstringThe service id; equals the name segment. Output only.
metaResourceMetaResource metadata.
specServiceEnablementSpecDesired state. Required.
statusServiceEnablementStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

ServiceEnablementSpec

FieldTypeWhat it is
enabledboolWhether the project's keys may reach the service. Required.

ServiceEnablementStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/service_enablements/service-enablement" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/service_enablements/service-enablement","spec":{"enabled":false}}'