GOgoogle
projects

POST /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}:disable

Changed on

Disables a plugin. The state of the plugin after disabling is DISABLED

Request

  • Base URL
    https://apihub.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/apihub.readwrite
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/apihub.readwrite
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectsIdstring required
locationsIdstring required
pluginsIdstring required

Request body

GoogleCloudApihubV1DisablePluginRequest required

The DisablePlugin method's request.

Response

Successful response

createTimestring google-datetime

Output only. Timestamp indicating when the plugin was created.

descriptionstring

Optional. The plugin description. Max length is 500000 characters (Unicode code points).

displayNamestring

Required. The display name of the plugin. Max length is 500 characters (Unicode code points).

gatewayType'GATEWAY_TYPE_UNSPECIFIED' | 'APIGEE_X_AND_HYBRID' | 'APIGEE_EDGE_PUBLIC_CLOUD' | 'APIGEE_EDGE_PRIVATE_CLOUD' | 'CLOUD_API_GATEWAY' | 'CLOUD_ENDPOINTS' | 'API_DISCOVERY' | 'OTHERS' | 'AWS_API_GATEWAY' | 'AZURE_API_MANAGEMENT'

Optional. The type of the gateway.

namestring

Identifier. The name of the plugin. Format: projects/{project}/locations/{location}/plugins/{plugin}

ownershipType'OWNERSHIP_TYPE_UNSPECIFIED' | 'SYSTEM_OWNED' | 'USER_OWNED'

Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.

pluginCategory'PLUGIN_CATEGORY_UNSPECIFIED' | 'API_GATEWAY' | 'API_PRODUCER'

Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.

state'STATE_UNSPECIFIED' | 'ENABLED' | 'DISABLED'

Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.

updateTimestring google-datetime

Output only. Timestamp indicating when the plugin was last updated.

Changes

  • 09b6c7d2247bRevision changes
    • info

      the security scope https://www.googleapis.com/auth/apihub.readwrite was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/apihub.readwrite was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c