2025-05-14
▼ ▲ apihub.projects.locations.searchResources
Path : v1/{+location}:searchResources
Flat Path : v1/projects/{projectsId}/locations/{locationsId}:searchResources
HTTP Method : POST
Parameters :
location
Description : Required. The resource name of the location which will be of the type `projects/{project_id}/locations/{location_id}`. This field is used to identify the instance of API-Hub in which resources should be searched.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : location
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Search across API-Hub resources.
▼ ▲ apihub.projects.locations.collectApiData
Path : v1/{+location}:collectApiData
Flat Path : v1/projects/{projectsId}/locations/{locationsId}:collectApiData
HTTP Method : POST
Parameters :
location
Description : Required. The regional location of the API hub instance and its resources. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : location
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Collect API data from a source and push it to Hub's collect layer.
▼ ▲ apihub.projects.locations.lookupRuntimeProjectAttachment
Path : v1/{+name}:lookupRuntimeProjectAttachment
Flat Path : v1/projects/{projectsId}/locations/{locationsId}:lookupRuntimeProjectAttachment
HTTP Method : GET
Parameters :
name
Description : Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Look up a runtime project attachment. This API can be called in the context of any project.
▼ ▲ apihub.projects.locations.list
Path : v1/{+name}/locations
Flat Path : v1/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
extraLocationTypes
Description : Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
Location : query
Repeated : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists information about the supported locations for this service.
▼ ▲ apihub.projects.locations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
▼ ▲ apihub.projects.locations.operations.list
Path : v1/{+name}/operations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ apihub.projects.locations.operations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets 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.
▼ ▲ apihub.projects.locations.operations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ apihub.projects.locations.operations.cancel
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
▼ ▲ apihub.projects.locations.plugins.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the plugin to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get an API Hub plugin.
▼ ▲ apihub.projects.locations.plugins.enable
Path : v1/{+name}:enable
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}:enable
HTTP Method : POST
Parameters :
name
Description : Required. The name of the plugin to enable. Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Enables a plugin. The `state` of the plugin after enabling is `ENABLED`
▼ ▲ apihub.projects.locations.plugins.disable
Path : v1/{+name}:disable
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}:disable
HTTP Method : POST
Parameters :
name
Description : Required. The name of the plugin to disable. Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Disables a plugin. The `state` of the plugin after disabling is `DISABLED`
▼ ▲ apihub.projects.locations.plugins.create
Path : v1/{+parent}/plugins
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pluginId
Description : Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/plugins/{plugin}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.
▼ ▲ apihub.projects.locations.plugins.list
Path : v1/{+parent}/plugins
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of plugins. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Plugins` are eligible for filtering: * `plugin_category` - The category of the Plugin. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `plugin_category = ON_RAMP` - The plugin is of category on ramp.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListPlugins` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListPlugins` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List all the plugins in a given project and location.
▼ ▲ apihub.projects.locations.plugins.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Plugin resource to delete. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
▼ ▲ apihub.projects.locations.plugins.getStyleGuide
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/styleGuide
HTTP Method : GET
Parameters :
name
Description : Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+/styleGuide$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the style guide being used for linting.
▼ ▲ apihub.projects.locations.plugins.updateStyleGuide
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/styleGuide
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the style guide. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+/styleGuide$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update the styleGuide to be used for liniting in by API hub.
▼ ▲ apihub.projects.locations.plugins.instances.create
Path : v1/{+parent}/instances
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances
HTTP Method : POST
Parameters :
parent
Description : Required. The parent of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+$
Location : path
Required : Yes
Type : string
pluginInstanceId
Description : Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another plugin instance in the plugin resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Plugin instance in the API hub.
▼ ▲ apihub.projects.locations.plugins.instances.executeAction
Path : v1/{+name}:executeAction
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:executeAction
HTTP Method : POST
Parameters :
name
Description : Required. The name of the plugin instance to execute. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Executes a plugin instance in the API hub.
▼ ▲ apihub.projects.locations.plugins.instances.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the plugin instance to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get an API Hub plugin instance.
▼ ▲ apihub.projects.locations.plugins.instances.list
Path : v1/{+parent}/instances
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}/plugins/{plugin}`. To list plugin instances for multiple plugins, use the - character instead of the plugin ID.
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of plugin instances. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `PluginInstances` are eligible for filtering: * `state` - The state of the Plugin Instance. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `state = ENABLED` - The plugin instance is in enabled state.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListPluginInstances` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluginInstances` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List all the plugins in a given project and location. `-` can be used as wildcard value for {plugin_id}
▼ ▲ apihub.projects.locations.plugins.instances.enableAction
Path : v1/{+name}:enableAction
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:enableAction
HTTP Method : POST
Parameters :
name
Description : Required. The name of the plugin instance to enable. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Enables a plugin instance in the API hub.
▼ ▲ apihub.projects.locations.plugins.instances.disableAction
Path : v1/{+name}:disableAction
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:disableAction
HTTP Method : POST
Parameters :
name
Description : Required. The name of the plugin instance to disable. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Disables a plugin instance in the API hub.
▼ ▲ apihub.projects.locations.plugins.instances.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the plugin instance to delete. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`.
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a plugin instance in the API hub.
▼ ▲ apihub.projects.locations.plugins.styleGuide.getContents
Path : v1/{+name}:contents
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/styleGuide:contents
HTTP Method : GET
Parameters :
name
Description : Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
Pattern : ^projects/[^/]+/locations/[^/]+/plugins/[^/]+/styleGuide$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the contents of the style guide.
▼ ▲ apihub.projects.locations.apis.create
Path : v1/{+parent}/apis
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for the API resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
apiId
Description : Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
▼ ▲ apihub.projects.locations.apis.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get API resource details including the API versions contained in it.
▼ ▲ apihub.projects.locations.apis.list
Path : v1/{+parent}/apis
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of API resources. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of ApiResources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not case sensitive. The following fields in the `ApiResource` are eligible for filtering: * `owner.email` - The email of the team which owns the ApiResource. Allowed comparison operators: `=`. * `create_time` - The time at which the ApiResource was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `display_name` - The display name of the ApiResource. Allowed comparison operators: `=`. * `target_user.enum_values.values.id` - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `target_user.enum_values.values.display_name` - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.id` - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.display_name` - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.id` - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.display_name` - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.id` - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.display_name` - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.id` - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.display_name` - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `owner.email = \"apihub@google.com\"` - - The owner team email is _apihub@google.com_. * `owner.email = \"apihub@google.com\" AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The owner team email is _apihub@google.com_ and the api was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `owner.email = \"apihub@google.com\" OR team.enum_values.values.id: apihub-team-id` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is _apihub-team-id_. * `owner.email = \"apihub@google.com\" OR team.enum_values.values.display_name: ApiHub Team` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is `ApiHub Team`. * `owner.email = \"apihub@google.com\" AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test_enum_id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/1765\0f90-4a29-5431-b3d0-d5532da3764c.string_values.values: test_string_value` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ and the id of the allowed value associated with the user defined attribute of type enum is _test_enum_id_ and the value of the user defined attribute of type string is _test_..
Location : query
Type : string
pageSize
Description : Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListApis` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List API resources in the API hub.
▼ ▲ apihub.projects.locations.apis.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.
▼ ▲ apihub.projects.locations.apis.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the API resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Location : path
Required : Yes
Type : string
force
Description : Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
▼ ▲ apihub.projects.locations.apis.versions.create
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for API version. Format: `projects/{project}/locations/{location}/apis/{api}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Location : path
Required : Yes
Type : string
versionId
Description : Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another version in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}`, its length is limited to 700 characters and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create an API version for an API resource in the API hub.
▼ ▲ apihub.projects.locations.apis.versions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the API version to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
▼ ▲ apihub.projects.locations.apis.versions.list
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions
HTTP Method : GET
Parameters :
parent
Description : Required. The parent which owns this collection of API versions i.e., the API resource Format: `projects/{project}/locations/{location}/apis/{api}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of Versions. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Version` are eligible for filtering: * `display_name` - The display name of the Version. Allowed comparison operators: `=`. * `create_time` - The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `lifecycle.enum_values.values.id` - The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`. * `lifecycle.enum_values.values.display_name` - The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`. * `compliance.enum_values.values.id` - The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators: `:`. * `compliance.enum_values.values.display_name` - The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators: `:`. * `accreditation.enum_values.values.id` - The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. * `accreditation.enum_values.values.display_name` - The allowed value display name of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `lifecycle.enum_values.values.id: preview-id` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_. * `lifecycle.enum_values.values.display_name: \"Preview Display Name\"` - The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version is `Preview Display Name`. * `lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_ and it was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id` - The id of the allowed value associated with the compliance attribute is _gdpr-id_ or _pci-dss-id_. * `lifecycle.enum_values.values.id: preview-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_ and the value of the user defined attribute of type string is _test_.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListVersions` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List API versions of an API resource in the API hub.
▼ ▲ apihub.projects.locations.apis.versions.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update API version. The following fields in the version can be updated currently: * display_name * description * documentation * deployments * lifecycle * compliance * accreditation * attributes The update_mask should be used to specify the fields being updated.
▼ ▲ apihub.projects.locations.apis.versions.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the version to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
force
Description : Optional. If set to true, any specs from this version will also be deleted. Otherwise, the request will only work if the version has no specs.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
▼ ▲ apihub.projects.locations.apis.versions.specs.create
Path : v1/{+parent}/specs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for Spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
specId
Description : Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another spec in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the `projects/{project}/locations/{location}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method.
▼ ▲ apihub.projects.locations.apis.versions.specs.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same.
▼ ▲ apihub.projects.locations.apis.versions.specs.getContents
Path : v1/{+name}:contents
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:contents
HTTP Method : GET
Parameters :
name
Description : Required. The name of the spec whose contents need to be retrieved. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get spec contents.
▼ ▲ apihub.projects.locations.apis.versions.specs.list
Path : v1/{+parent}/specs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of specs. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not case sensitive. The following fields in the `Spec` are eligible for filtering: * `display_name` - The display name of the Spec. Allowed comparison operators: `=`. * `create_time` - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `spec_type.enum_values.values.id` - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `spec_type.enum_values.values.display_name` - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `lint_response.json_values.values` - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: `:`. * `mime_type` - The MIME type of the Spec. Allowed comparison operators: `=`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `spec_type.enum_values.values.id: rest-id` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_. * `spec_type.enum_values.values.display_name: \"Rest Display Name\"` - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is `Rest Display Name`. * `spec_type.enum_values.values.id: grpc-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The id of the allowed value associated with the spec_type attribute is _grpc-id_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `spec_type.enum_values.values.id: rest-id OR spec_type.enum_values.values.id: grpc-id` - The id of the allowed value associated with the spec_type attribute is _rest-id_ or _grpc-id_. * `spec_type.enum_values.values.id: rest-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_ and the id of the allowed value associated with the user defined attribute of type enum is _test_.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSpecs` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List specs corresponding to a particular API resource.
▼ ▲ apihub.projects.locations.apis.versions.specs.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The update_mask should be used to specify the fields being updated.
▼ ▲ apihub.projects.locations.apis.versions.specs.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the spec to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a spec. Deleting a spec will also delete the associated operations from the version.
▼ ▲ apihub.projects.locations.apis.versions.specs.lint
Path : v1/{+name}:lint
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:lint
HTTP Method : POST
Parameters :
name
Description : Required. The name of the spec to be linted. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.
▼ ▲ apihub.projects.locations.apis.versions.operations.create
Path : v1/{+parent}/operations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for the operation resource. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
apiOperationId
Description : Optional. The ID to use for the operation resource, which will become the final component of the operation's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another operation resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`, its length is limited to 700 characters, and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create an apiOperation in an API version. An apiOperation can be created only if the version has no apiOperations which were created by parsing a spec.
▼ ▲ apihub.projects.locations.apis.versions.operations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the operation to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get details about a particular operation in API version.
▼ ▲ apihub.projects.locations.apis.versions.operations.list
Path : v1/{+parent}/operations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations
HTTP Method : GET
Parameters :
parent
Description : Required. The parent which owns this collection of operations i.e., the API version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of ApiOperations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `ApiOperation` are eligible for filtering: * `name` - The ApiOperation resource name. Allowed comparison operators: `=`. * `details.http_operation.path.path` - The http operation's complete path relative to server endpoint. Allowed comparison operators: `=`. * `details.http_operation.method` - The http operation method type. Allowed comparison operators: `=`. * `details.deprecated` - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: `=`. * `create_time` - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `details.deprecated = True` - The ApiOperation is deprecated. * `details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The method of the http operation of the ApiOperation is _GET_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `details.http_operation.method = GET OR details.http_operation.method = POST`. - The http operation of the method of ApiOperation is _GET_ or _POST_. * `details.deprecated = True AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the ApiOperation is deprecated and the value of the user defined attribute of type string is _test_.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListApiOperations` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List operations in an API version.
▼ ▲ apihub.projects.locations.apis.versions.operations.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations/{operationsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.
▼ ▲ apihub.projects.locations.apis.versions.operations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the operation resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete an operation in an API version and we can delete only the operations created via create API. If the operation was created by parsing the spec, then it can be deleted by editing or deleting the spec.
▼ ▲ apihub.projects.locations.apis.versions.definitions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/definitions/{definitionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the definition to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
Pattern : ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/definitions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get details about a definition in an API version.
▼ ▲ apihub.projects.locations.deployments.create
Path : v1/{+parent}/deployments
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for the deployment resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
deploymentId
Description : Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another deployment resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
▼ ▲ apihub.projects.locations.deployments.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the deployment resource to retrieve. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
Pattern : ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get details about a deployment and the API versions linked to it.
▼ ▲ apihub.projects.locations.deployments.list
Path : v1/{+parent}/deployments
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of deployment resources. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of Deployments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Deployments` are eligible for filtering: * `display_name` - The display name of the Deployment. Allowed comparison operators: `=`. * `create_time` - The time at which the Deployment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `resource_uri` - A URI to the deployment resource. Allowed comparison operators: `=`. * `api_versions` - The API versions linked to this deployment. Allowed comparison operators: `:`. * `deployment_type.enum_values.values.id` - The allowed value id of the deployment_type attribute associated with the Deployment. Allowed comparison operators: `:`. * `deployment_type.enum_values.values.display_name` - The allowed value display name of the deployment_type attribute associated with the Deployment. Allowed comparison operators: `:`. * `slo.string_values.values` -The allowed string value of the slo attribute associated with the deployment. Allowed comparison operators: `:`. * `environment.enum_values.values.id` - The allowed value id of the environment attribute associated with the deployment. Allowed comparison operators: `:`. * `environment.enum_values.values.display_name` - The allowed value display name of the environment attribute associated with the deployment. Allowed comparison operators: `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `environment.enum_values.values.id: staging-id` - The allowed value id of the environment attribute associated with the Deployment is _staging-id_. * `environment.enum_values.values.display_name: \"Staging Deployment\"` - The allowed value display name of the environment attribute associated with the Deployment is `Staging Deployment`. * `environment.enum_values.values.id: production-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The allowed value id of the environment attribute associated with the Deployment is _production-id_ and Deployment was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `environment.enum_values.values.id: production-id OR slo.string_values.values: \"99.99%\"` - The allowed value id of the environment attribute Deployment is _production-id_ or string value of the slo attribute is _99.99%_. * `environment.enum_values.values.id: staging-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the allowed value id of the environment attribute associated with the Deployment is _staging-id_ and the value of the user defined attribute of type string is _test_.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of deployment resources to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListDeployments` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List deployment resources in the API hub.
▼ ▲ apihub.projects.locations.deployments.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
Pattern : ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a deployment resource in the API hub. The following fields in the deployment resource can be updated: * display_name * description * documentation * deployment_type * resource_uri * endpoints * slo * environment * attributes The update_mask should be used to specify the fields being updated.
▼ ▲ apihub.projects.locations.deployments.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the deployment resource to delete. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
Pattern : ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a deployment resource in the API hub.
▼ ▲ apihub.projects.locations.attributes.create
Path : v1/{+parent}/attributes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/attributes
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for Attribute. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
attributeId
Description : Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another attribute resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as `SYSTEM_DEFINED` and can be listed via ListAttributes method. Allowed values for the same can be updated via UpdateAttribute method.
▼ ▲ apihub.projects.locations.attributes.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/attributes/{attributesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the attribute to retrieve. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
Pattern : ^projects/[^/]+/locations/[^/]+/attributes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get details about the attribute.
▼ ▲ apihub.projects.locations.attributes.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/attributes/{attributesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
Pattern : ^projects/[^/]+/locations/[^/]+/attributes/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update the attribute. The following fields in the Attribute resource can be updated: * display_name The display name can be updated for user defined attributes only. * description The description can be updated for user defined attributes only. * allowed_values To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted. * cardinality The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update. The update_mask should be used to specify the fields being updated.
▼ ▲ apihub.projects.locations.attributes.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/attributes/{attributesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the attribute to delete. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
Pattern : ^projects/[^/]+/locations/[^/]+/attributes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
▼ ▲ apihub.projects.locations.attributes.list
Path : v1/{+parent}/attributes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/attributes
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource for Attribute. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of Attributes. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Attribute` are eligible for filtering: * `display_name` - The display name of the Attribute. Allowed comparison operators: `=`. * `definition_type` - The definition type of the attribute. Allowed comparison operators: `=`. * `scope` - The scope of the attribute. Allowed comparison operators: `=`. * `data_type` - The type of the data of the attribute. Allowed comparison operators: `=`. * `mandatory` - Denotes whether the attribute is mandatory or not. Allowed comparison operators: `=`. * `create_time` - The time at which the Attribute was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `display_name = production` - - The display name of the attribute is _production_. * `(display_name = production) AND (create_time < \"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\")` - The display name of the attribute is _production_ and the attribute was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `display_name = production OR scope = api` - The attribute where the display name is _production_ or the scope is _api_.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of attribute resources to return. The service may return fewer than this value. If unspecified, at most 50 attributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListAttributes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAttributes` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List all attributes.
▼ ▲ apihub.projects.locations.externalApis.create
Path : v1/{+parent}/externalApis
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/externalApis
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for the External API resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
externalApiId
Description : Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create an External API resource in the API hub.
▼ ▲ apihub.projects.locations.externalApis.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the External API resource to retrieve. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}`
Pattern : ^projects/[^/]+/locations/[^/]+/externalApis/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get details about an External API resource in the API hub.
▼ ▲ apihub.projects.locations.externalApis.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.
Pattern : ^projects/[^/]+/locations/[^/]+/externalApis/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update an External API resource in the API hub. The following fields can be updated: * display_name * description * documentation * endpoints * paths The update_mask should be used to specify the fields being updated.
▼ ▲ apihub.projects.locations.externalApis.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the External API resource to delete. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}`
Pattern : ^projects/[^/]+/locations/[^/]+/externalApis/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete an External API resource in the API hub.
▼ ▲ apihub.projects.locations.externalApis.list
Path : v1/{+parent}/externalApis
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/externalApis
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of External API resources. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of External API resources to return. The service may return fewer than this value. If unspecified, at most 50 ExternalApis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListExternalApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListExternalApis` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List External API resources in the API hub.
▼ ▲ apihub.projects.locations.dependencies.create
Path : v1/{+parent}/dependencies
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dependencies
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for the dependency resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
dependencyId
Description : Optional. The ID to use for the dependency resource, which will become the final component of the dependency's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if duplicate id is provided by the client. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are `a-z[0-9]-_`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a dependency between two entities in the API hub.
▼ ▲ apihub.projects.locations.dependencies.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dependencies/{dependenciesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the dependency resource to retrieve. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
Pattern : ^projects/[^/]+/locations/[^/]+/dependencies/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get details about a dependency resource in the API hub.
▼ ▲ apihub.projects.locations.dependencies.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dependencies/{dependenciesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
Pattern : ^projects/[^/]+/locations/[^/]+/dependencies/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a dependency based on the update_mask provided in the request. The following fields in the dependency can be updated: * description
▼ ▲ apihub.projects.locations.dependencies.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dependencies/{dependenciesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the dependency resource to delete. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
Pattern : ^projects/[^/]+/locations/[^/]+/dependencies/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete the dependency resource.
▼ ▲ apihub.projects.locations.dependencies.list
Path : v1/{+parent}/dependencies
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dependencies
HTTP Method : GET
Parameters :
parent
Description : Required. The parent which owns this collection of dependency resources. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of Dependencies. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. Allowed comparison operator is `=`. Filters are not case sensitive. The following fields in the `Dependency` are eligible for filtering: * `consumer.operation_resource_name` - The operation resource name for the consumer entity involved in a dependency. Allowed comparison operators: `=`. * `consumer.external_api_resource_name` - The external api resource name for the consumer entity involved in a dependency. Allowed comparison operators: `=`. * `supplier.operation_resource_name` - The operation resource name for the supplier entity involved in a dependency. Allowed comparison operators: `=`. * `supplier.external_api_resource_name` - The external api resource name for the supplier entity involved in a dependency. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. For example, `consumer.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR supplier.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\"` - The dependencies with either consumer or supplier operation resource name as _projects/p1/locations/global/apis/a1/versions/v1/operations/o1_.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of dependency resources to return. The service may return fewer than this value. If unspecified, at most 50 dependencies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListDependencies` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDependencies` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List dependencies based on the provided filter and pagination parameters.
▼ ▲ apihub.projects.locations.curations.create
Path : v1/{+parent}/curations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/curations
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for the curation resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
curationId
Description : Optional. The ID to use for the curation resource, which will become the final component of the curations's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub. * If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.
▼ ▲ apihub.projects.locations.curations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/curations/{curationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the curation resource to retrieve. Format: `projects/{project}/locations/{location}/curations/{curation}`
Pattern : ^projects/[^/]+/locations/[^/]+/curations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get curation resource details.
▼ ▲ apihub.projects.locations.curations.list
Path : v1/{+parent}/curations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/curations
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of curation resources. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression that filters the list of curation resources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are case insensitive. The following fields in the `curation resource` are eligible for filtering: * `create_time` - The time at which the curation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `display_name` - The display name of the curation. Allowed comparison operators: `=`. * `state` - The state of the curation. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The curation resource was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of curation resources to return. The service may return fewer than this value. If unspecified, at most 50 curations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListCurations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListCurations` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List curation resources in the API hub.
▼ ▲ apihub.projects.locations.curations.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/curations/{curationsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`
Pattern : ^projects/[^/]+/locations/[^/]+/curations/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a curation resource in the API hub. The following fields in the curation can be updated: * display_name * description The update_mask should be used to specify the fields being updated.
▼ ▲ apihub.projects.locations.curations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/curations/{curationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the curation resource to delete. Format: `projects/{project}/locations/{location}/curations/{curation}`
Pattern : ^projects/[^/]+/locations/[^/]+/curations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.
▼ ▲ apihub.projects.locations.hostProjectRegistrations.create
Path : v1/{+parent}/hostProjectRegistrations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/hostProjectRegistrations
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for the host project. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
hostProjectRegistrationId
Description : Required. The ID to use for the Host Project Registration, which will become the final component of the host project registration's resource name. The ID must be the same as the Google cloud project specified in the host_project_registration.gcp_project field.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.
▼ ▲ apihub.projects.locations.hostProjectRegistrations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/hostProjectRegistrations/{hostProjectRegistrationsId}
HTTP Method : GET
Parameters :
name
Description : Required. Host project registration resource name. projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration_id}
Pattern : ^projects/[^/]+/locations/[^/]+/hostProjectRegistrations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a host project registration.
▼ ▲ apihub.projects.locations.hostProjectRegistrations.list
Path : v1/{+parent}/hostProjectRegistrations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/hostProjectRegistrations
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of host projects. Format: `projects/*/locations/*`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of host project registrations to return. The service may return fewer than this value. If unspecified, at most 50 host project registrations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListHostProjectRegistrations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListHostProjectRegistrations` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. An expression that filters the list of HostProjectRegistrations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `HostProjectRegistration` are eligible for filtering: * `name` - The name of the HostProjectRegistration. * `create_time` - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * `gcp_project` - The Google cloud project associated with the HostProjectRegistration.
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists host project registrations.
▼ ▲ apihub.projects.locations.apiHubInstances.create
Path : v1/{+parent}/apiHubInstances
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for the Api Hub instance resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
apiHubInstanceId
Description : Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are `/a-z[0-9]-_/`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Provisions instance resources for the API Hub.
▼ ▲ apihub.projects.locations.apiHubInstances.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances/{apiHubInstancesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Api Hub instance to delete. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
Pattern : ^projects/[^/]+/locations/[^/]+/apiHubInstances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes the API hub instance.
▼ ▲ apihub.projects.locations.apiHubInstances.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances/{apiHubInstancesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Api Hub instance to retrieve. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
Pattern : ^projects/[^/]+/locations/[^/]+/apiHubInstances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single API Hub instance.
▼ ▲ apihub.projects.locations.apiHubInstances.lookup
Path : v1/{+parent}/apiHubInstances:lookup
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances:lookup
HTTP Method : GET
Parameters :
parent
Description : Required. There will always be only one Api Hub instance for a GCP project across all locations. The parent resource for the Api Hub instance resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.
▼ ▲ apihub.projects.locations.runtimeProjectAttachments.create
Path : v1/{+parent}/runtimeProjectAttachments
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource for the Runtime Project Attachment. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
runtimeProjectAttachmentId
Description : Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment's name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Attaches a runtime project to the host project.
▼ ▲ apihub.projects.locations.runtimeProjectAttachments.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments/{runtimeProjectAttachmentsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}`
Pattern : ^projects/[^/]+/locations/[^/]+/runtimeProjectAttachments/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a runtime project attachment.
▼ ▲ apihub.projects.locations.runtimeProjectAttachments.list
Path : v1/{+parent}/runtimeProjectAttachments
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of runtime project attachments. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of runtime project attachments to return. The service may return fewer than this value. If unspecified, at most 50 runtime project attachments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListRuntimeProjectAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListRuntimeProjectAttachments` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. An expression that filters the list of RuntimeProjectAttachments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `RuntimeProjectAttachment` are eligible for filtering: * `name` - The name of the RuntimeProjectAttachment. * `create_time` - The time at which the RuntimeProjectAttachment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * `runtime_project` - The Google cloud project associated with the RuntimeProjectAttachment.
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List runtime projects attached to the host project.
▼ ▲ apihub.projects.locations.runtimeProjectAttachments.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments/{runtimeProjectAttachmentsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Runtime Project Attachment to delete. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}`
Pattern : ^projects/[^/]+/locations/[^/]+/runtimeProjectAttachments/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.