Service Management API
Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service…
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.
Endpoints 19
operations
- GETGets the latest state of a long-running operation
/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - GETLists service operations that match the specified filter in the request.
/v1/operations?filter=string&name=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists service operations that match the specified filter in the request.
services
- GETLists managed services
/v1/services?consumerId=string&pageSize=0&pageToken=string&producerProjectId=stringLists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get"… - POSTCreates a new managed service
/v1/servicesCreates a new managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it… - GETGets a managed service
/v1/services/:serviceNameGets a managed service. Authentication is required unless the service is public. - DELETEDeletes a managed service
/v1/services/:serviceNameDeletes a managed service. This method will change the service to the Soft-Delete state for 30 days. Within this period, service producers may call… - POSTGenerates and returns a report (errors, warnings and changes from existing configurations) associated with…
/v1/services:generateConfigReportGenerates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If… - GETGets a service configuration (version) for a managed service.
/v1/services/:serviceName/config?configId=string&view=BASICGets a service configuration (version) for a managed service. - POSTRevives a previously deleted managed service
/v1/services/:serviceName:undeleteRevives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service…
services.consumers
- POSTGets the access control policy for a resource
/v1/:resource:getIamPolicyGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - POSTSets the access control policy on the specified resource
/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - POSTReturns permissions that a caller has on the specified resource
/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…
services.configs
- GETLists the history of the service configuration for a managed service, from the newest to the oldest.
/v1/services/:serviceName/configs?pageSize=0&pageToken=stringLists the history of the service configuration for a managed service, from the newest to the oldest. - POSTCreates a new service configuration (version) for a managed service
/v1/services/:serviceName/configsCreates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration… - GETGets a service configuration (version) for a managed service.
/v1/services/:serviceName/configs/:configId?view=BASICGets a service configuration (version) for a managed service. - POSTCreates a new service configuration (version) for a managed service based on user-supplied configuration source files…
/v1/services/:serviceName/configs:submitCreates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification).…
services.rollouts
- GETLists the history of the service configuration rollouts for a managed service, from the newest to the oldest.
/v1/services/:serviceName/rollouts?filter=string&pageSize=0&pageToken=stringLists the history of the service configuration rollouts for a managed service, from the newest to the oldest. - POSTCreates a new service configuration rollout
/v1/services/:serviceName/rolloutsCreates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend… - GETGets a service configuration rollout.
/v1/services/:serviceName/rollouts/:rolloutIdGets a service configuration rollout.
API details
- Base URL
https://servicemanagement.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 4 scopes
An API key in the key query parameter - Operations
- 19 operations on 15 pathsGET 9POST 9DELETE 1
- Main resources
- services 7services.configs 4services.consumers 3services.rollouts 3operations 2
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Service Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Service Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 4 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Service Management API?
Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service… It is listed under Developer tools and has 19 endpoints.
Who publishes the Service Management API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Service Management API?
Requests go to https://servicemanagement.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Service Management API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 4 scopes; an API key in the key query parameter.
How many endpoints does the Service Management API have?
19 operations on 15 paths (9 GET, 9 POST, 1 DELETE). The largest groups are services, services.configs, services.consumers, services.rollouts.
Is forking the Service Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.