Observability API
Provides functionality for configuring the observability scope, which controls the log, metric, and trace data that you can view.
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
Provides functionality for configuring the observability scope, which controls the log, metric, and trace data that you can view.
Endpoints 15
projects.locations.traceScopes
- GETGet TraceScope resource.
/v1/:nameGet TraceScope resource. - DELETEDelete a TraceScope.
/v1/:nameDelete a TraceScope. - PATCHUpdate a TraceScope.
/v1/:name?updateMask=stringUpdate a TraceScope. - GETList TraceScopes of a project in a particular location.
/v1/:parent/traceScopes?pageSize=0&pageToken=stringList TraceScopes of a project in a particular location. - POSTCreate a new TraceScope.
/v1/:parent/traceScopes?traceScopeId=stringCreate a new TraceScope.
projects.locations
- GETLists information about the supported locations for this service
/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
projects.locations.operations
- POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.locations.buckets
- GETList buckets of a project in a particular location.
/v1/:parent/buckets?pageSize=0&pageToken=string&showDeleted=trueList buckets of a project in a particular location. - POSTCreate a new bucket.
/v1/:parent/buckets?bucketId=stringCreate a new bucket. - POSTInitiates reprovisioning of a bucket
/v1/:name:reprovisionInitiates reprovisioning of a bucket. This is allowed only a single time for a bucket and results in data loss. Subsequent calls to this method for the same…
projects.locations.buckets.datasets
- GETList datasets of a bucket.
/v1/:parent/datasets?pageSize=0&pageToken=string&showDeleted=trueList datasets of a bucket.
projects.locations.buckets.datasets.links
- GETList links of a dataset.
/v1/:parent/links?pageSize=0&pageToken=stringList links of a dataset. - POSTCreate a new link.
/v1/:parent/links?linkId=stringCreate a new link.
projects.locations.buckets.datasets.views
- GETList views of a dataset.
/v1/:parent/views?pageSize=0&pageToken=stringList views of a dataset.
API details
- Base URL
https://observability.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 15 operations on 10 pathsGET 8POST 5PATCH 1DELETE 1
- Main resources
- projects.locations.traceScopes 5projects.locations.buckets 3projects.locations.buckets.datasets.links 2projects.locations.operations 2projects.locations 1projects.locations.buckets.datasets 1projects.locations.buckets.datasets.views 1
- 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 Observability 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 Observability API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get TraceScope resource.” (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 Observability API?
Provides functionality for configuring the observability scope, which controls the log, metric, and trace data that you can view. It is listed under Developer tools and has 15 endpoints.
Who publishes the Observability 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 Observability API?
Requests go to https://observability.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Observability API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Observability API have?
15 operations on 10 paths (8 GET, 5 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.traceScopes, projects.locations.buckets, projects.locations.buckets.datasets.links, projects.locations.operations.
Is forking the Observability API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.