Observability API

Provides functionality for configuring the observability scope, which controls the log, metric, and trace data that you can view.

Service: observability.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://observability.googleapis.com

Regional service endpoint

A regional service endpoint is a base URL that specifies the network address of an API service in a single region. A service that is available in multiple regions might have multiple regional endpoints. Select a location to see its regional service endpoint for this service.


  • https://observability.googleapis.com

    • REST Resource: v1.folders.locations

    Methods
    get GET /v1/{name=folders/*/locations/*}
    Gets information about a location.
    getSettings GET /v1/{name=folders/*/locations/*/settings}
    Get Settings
    list GET /v1/{name=folders/*}/locations
    Lists information about the supported locations for this service.
    updateSettings PATCH /v1/{settings.name=folders/*/locations/*/settings}
    Update Settings

    REST Resource: v1.folders.locations.operations

    Methods
    cancel POST /v1/{name=folders/*/locations/*/operations/*}:cancel
    Starts asynchronous cancellation on a long-running operation.
    delete DELETE /v1/{name=folders/*/locations/*/operations/*}
    Deletes a long-running operation.
    get GET /v1/{name=folders/*/locations/*/operations/*}
    Gets the latest state of a long-running operation.
    list GET /v1/{name=folders/*/locations/*}/operations
    Lists operations that match the specified filter in the request.

    REST Resource: v1.organizations.locations

    Methods
    get GET /v1/{name=organizations/*/locations/*}
    Gets information about a location.
    getSettings GET /v1/{name=organizations/*/locations/*/settings}
    Get Settings
    list GET /v1/{name=organizations/*}/locations
    Lists information about the supported locations for this service.
    updateSettings PATCH /v1/{settings.name=organizations/*/locations/*/settings}
    Update Settings

    REST Resource: v1.organizations.locations.operations

    Methods
    cancel POST /v1/{name=organizations/*/locations/*/operations/*}:cancel
    Starts asynchronous cancellation on a long-running operation.
    delete DELETE /v1/{name=organizations/*/locations/*/operations/*}
    Deletes a long-running operation.
    get GET /v1/{name=organizations/*/locations/*/operations/*}
    Gets the latest state of a long-running operation.
    list GET /v1/{name=organizations/*/locations/*}/operations
    Lists operations that match the specified filter in the request.

    REST Resource: v1.projects.locations

    Methods
    get GET /v1/{name=projects/*/locations/*}
    Gets information about a location.
    getSettings GET /v1/{name=projects/*/locations/*/settings}
    Get Settings
    list GET /v1/{name=projects/*}/locations
    Lists information about the supported locations for this service.
    updateSettings PATCH /v1/{settings.name=projects/*/locations/*/settings}
    Update Settings

    REST Resource: v1.projects.locations.buckets

    Methods
    get GET /v1/{name=projects/*/locations/*/buckets/*}
    Get bucket resource.
    list GET /v1/{parent=projects/*/locations/*}/buckets
    List buckets of a project in a particular location.

    REST Resource: v1.projects.locations.buckets.datasets

    Methods
    get GET /v1/{name=projects/*/locations/*/buckets/*/datasets/*}
    Get a dataset.
    list GET /v1/{parent=projects/*/locations/*/buckets/*}/datasets
    List datasets of a bucket.

    REST Resource: v1.projects.locations.buckets.datasets.views

    Methods
    get GET /v1/{name=projects/*/locations/*/buckets/*/datasets/*/views/*}
    Get a view.
    list GET /v1/{parent=projects/*/locations/*/buckets/*/datasets/*}/views
    List views of a dataset.

    REST Resource: v1.projects.locations.operations

    Methods
    cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
    Starts asynchronous cancellation on a long-running operation.
    delete DELETE /v1/{name=projects/*/locations/*/operations/*}
    Deletes a long-running operation.
    get GET /v1/{name=projects/*/locations/*/operations/*}
    Gets the latest state of a long-running operation.
    list GET /v1/{name=projects/*/locations/*}/operations
    Lists operations that match the specified filter in the request.

    REST Resource: v1.projects.locations.scopes

    Methods
    get GET /v1/{name=projects/*/locations/*/scopes/*}
    Gets details of a single Scope.
    patch PATCH /v1/{scope.name=projects/*/locations/*/scopes/*}
    Updates the parameters of a single Scope.

    REST Resource: v1.projects.locations.traceScopes

    Methods
    create POST /v1/{parent=projects/*/locations/*}/traceScopes
    Create a new TraceScope.
    delete DELETE /v1/{name=projects/*/locations/*/traceScopes/*}
    Delete a TraceScope.
    get GET /v1/{name=projects/*/locations/*/traceScopes/*}
    Get TraceScope resource.
    list GET /v1/{parent=projects/*/locations/*}/traceScopes
    List TraceScopes of a project in a particular location.
    patch PATCH /v1/{traceScope.name=projects/*/locations/*/traceScopes/*}
    Update a TraceScope.