2022-05-05
▼ ▲ apigeeregistry.projects.locations.get
Parameter Order: name
Description: Gets information about a location.
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Resource name for the location.
Location: path
Path: v1/{+name}
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
▼ ▲ apigeeregistry.projects.locations.list
Path: v1/{+name}/locations
Description: Lists information about the supported locations for this service.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations
Parameters:
pageToken
Location: query
Type: string
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
name
Location: path
Pattern: ^projects/[^/]+$
Description: The resource that owns the locations collection, if applicable.
Required: Yes
Type: string
filter
Location: query
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).
Type: string
pageSize
Description: The maximum number of results to return. If not set, the service selects a default.
Format: int32
Location: query
Type: integer
▼ ▲ apigeeregistry.projects.locations.operations.delete
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Type: string
Location: path
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: DELETE
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`.
▼ ▲ apigeeregistry.projects.locations.operations.cancel
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Description: The name of the operation resource to be cancelled.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Path: v1/{+name}:cancel
HTTP Method: POST
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`.
▼ ▲ apigeeregistry.projects.locations.operations.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Location: path
Type: string
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
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.
HTTP Method: GET
▼ ▲ apigeeregistry.projects.locations.operations.list
HTTP Method: GET
Path: v1/{+name}/operations
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Type: integer
Format: int32
Location: query
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ apigeeregistry.projects.locations.instances.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location: path
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Type: string
Required: Yes
Path: v1/{+resource}:setIamPolicy
▼ ▲ apigeeregistry.projects.locations.instances.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Parameter Order: resource
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
options.requestedPolicyVersion
Location: query
Format: int32
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Type: string
Location: path
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy
▼ ▲ apigeeregistry.projects.locations.instances.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Instance.
HTTP Method: GET
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Required: Yes
Description: Required. The name of the Instance to retrieve. Format: `projects/*/locations/*/instances/*`.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
Path: v1/{+name}
▼ ▲ apigeeregistry.projects.locations.instances.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes the Registry instance.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Type: string
Description: Required. The name of the Instance to delete. Format: `projects/*/locations/*/instances/*`.
Location: path
Required: Yes
Parameter Order: name
Path: v1/{+name}
▼ ▲ apigeeregistry.projects.locations.instances.testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
Location: path
Type: string
HTTP Method: POST
Path: v1/{+resource}:testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions
Parameter Order: resource
▼ ▲ apigeeregistry.projects.locations.instances.create
HTTP Method: POST
Parameters:
instanceId
Location: query
Type: string
Description: Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. Parent resource of the Instance, of the form: `projects/*/locations/*`
Type: string
Location: path
Parameter Order: parent
Path: v1/{+parent}/instances
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/instances
Description: Provisions instance resources for the Registry.
▼ ▲ apigeeregistry.projects.locations.runtime.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameter Order: resource
Path: v1/{+resource}:setIamPolicy
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/runtime$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/runtime:setIamPolicy
▼ ▲ apigeeregistry.projects.locations.runtime.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/runtime:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/runtime$
Location: path
Type: string
options.requestedPolicyVersion
Location: query
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
Format: int32
Parameter Order: resource
▼ ▲ apigeeregistry.projects.locations.runtime.testIamPermissions
Parameters:
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/runtime$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/runtime:testIamPermissions
Path: v1/{+resource}:testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order: resource
HTTP Method: POST
▼ ▲ apigeeregistry.projects.locations.apis.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+parent}/apis
Description: ListApis returns matching APIs.
Parameters:
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApis` must match the call that provided the page token.
pageSize
Format: int32
Type: integer
Description: The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The parent, which owns this collection of APIs. Format: projects/*/locations/*
Location: path
Required: Yes
filter
Description: An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Location: query
Type: string
▼ ▲ apigeeregistry.projects.locations.apis.create
Description: CreateApi creates a specified API.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
apiId
Type: string
Location: query
Description: Required. The ID to use for the api, which will become the final component of the api's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Description: Required. The parent, which owns this collection of APIs. Format: projects/*/locations/*
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis
Parameter Order: parent
Path: v1/{+parent}/apis
HTTP Method: POST
▼ ▲ apigeeregistry.projects.locations.apis.testIamPermissions
Parameter Order: resource
Path: v1/{+resource}:testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
Type: string
Location: path
▼ ▲ apigeeregistry.projects.locations.apis.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Path: v1/{+name}
Parameters:
allowMissing
Type: boolean
Location: query
Description: If set to true, and the api is not found, a new api will be created. In this situation, `update_mask` is ignored.
updateMask
Type: string
Description: The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
Format: google-fieldmask
Location: query
name
Type: string
Location: path
Description: Resource name.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Description: UpdateApi can be used to modify a specified API.
Parameter Order: name
▼ ▲ apigeeregistry.projects.locations.apis.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}
Parameter Order: name
Description: DeleteApi removes a specified API and all of the resources that it owns.
Path: v1/{+name}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Description: Required. The name of the API to delete. Format: projects/*/locations/*/apis/*
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Required: Yes
▼ ▲ apigeeregistry.projects.locations.apis.setIamPolicy
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameters:
resource
Location: path
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
▼ ▲ apigeeregistry.projects.locations.apis.get
Parameter Order: name
Description: GetApi returns a specified API.
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Description: Required. The name of the API to retrieve. Format: projects/*/locations/*/apis/*
Location: path
HTTP Method: GET
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}
▼ ▲ apigeeregistry.projects.locations.apis.getIamPolicy
HTTP Method: GET
Parameter Order: resource
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options.requestedPolicyVersion
Format: int32
Location: query
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:getIamPolicy
▼ ▲ apigeeregistry.projects.locations.apis.versions.setIamPolicy
HTTP Method: POST
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path: v1/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Required: Yes
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location: path
▼ ▲ apigeeregistry.projects.locations.apis.versions.testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location: path
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Type: string
Required: Yes
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ apigeeregistry.projects.locations.apis.versions.list
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions
Parameters:
pageSize
Description: The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
parent
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Description: Required. The parent, which owns this collection of versions. Format: projects/*/locations/*/apis/*
pageToken
Type: string
Description: A page token, received from a previous `ListApiVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiVersions` must match the call that provided the page token.
Location: query
filter
Location: query
Type: string
Description: An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Path: v1/{+parent}/versions
Description: ListApiVersions returns matching versions.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ apigeeregistry.projects.locations.apis.versions.get
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}
Parameter Order: name
Description: GetApiVersion returns a specified version.
Parameters:
name
Required: Yes
Description: Required. The name of the version to retrieve. Format: projects/*/locations/*/apis/*/versions/*
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location: path
Type: string
▼ ▲ apigeeregistry.projects.locations.apis.versions.getIamPolicy
Parameters:
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Location: path
options.requestedPolicyVersion
Location: query
Format: int32
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameter Order: resource
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:getIamPolicy
▼ ▲ apigeeregistry.projects.locations.apis.versions.create
Description: CreateApiVersion creates a specified version.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions
Parameters:
apiVersionId
Description: Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Type: string
Location: query
parent
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Description: Required. The parent, which owns this collection of versions. Format: projects/*/locations/*/apis/*
Required: Yes
Path: v1/{+parent}/versions
Parameter Order: parent
HTTP Method: POST
▼ ▲ apigeeregistry.projects.locations.apis.versions.delete
Path: v1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}
Parameters:
name
Description: Required. The name of the version to delete. Format: projects/*/locations/*/apis/*/versions/*
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type: string
Location: path
Description: DeleteApiVersion removes a specified version and all of the resources that it owns.
HTTP Method: DELETE
▼ ▲ apigeeregistry.projects.locations.apis.versions.patch
HTTP Method: PATCH
Path: v1/{+name}
Parameter Order: name
Description: UpdateApiVersion can be used to modify a specified version.
Parameters:
allowMissing
Type: boolean
Description: If set to true, and the version is not found, a new version will be created. In this situation, `update_mask` is ignored.
Location: query
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type: string
Required: Yes
Description: Resource name.
updateMask
Format: google-fieldmask
Description: The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
Type: string
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.create
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/artifacts
Parameters:
parent
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
artifactId
Description: Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Location: query
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts
Description: CreateArtifact creates a specified artifact.
Parameter Order: parent
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.get
Description: GetArtifact returns a specified artifact.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}
Parameters:
name
Description: Required. The name of the artifact to retrieve. Format: {parent}/artifacts/*
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Type: integer
Description: The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Format: int32
Location: query
pageToken
Location: query
Description: A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type: string
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
Location: path
Required: Yes
filter
Description: An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Location: query
Type: string
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts
Description: ListArtifacts returns matching artifacts.
Path: v1/{+parent}/artifacts
Parameter Order: parent
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.replaceArtifact
HTTP Method: PUT
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Description: Resource name.
Required: Yes
Type: string
Location: path
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: ReplaceArtifact can be used to replace a specified artifact.
Parameter Order: name
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.setIamPolicy
Parameter Order: resource
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Required: Yes
Type: string
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.getIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
options.requestedPolicyVersion
Location: query
Format: int32
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Required: Yes
Location: path
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getIamPolicy
Path: v1/{+resource}:getIamPolicy
HTTP Method: GET
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.delete
Description: DeleteArtifact removes a specified artifact.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}
Path: v1/{+name}
Parameters:
name
Description: Required. The name of the artifact to delete. Format: {parent}/artifacts/*
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: DELETE
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.getContents
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getContents
Description: GetArtifactContents returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
Path: v1/{+name}:getContents
Parameters:
name
Required: Yes
Description: Required. The name of the artifact whose contents should be retrieved. Format: {parent}/artifacts/*
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Location: path
Type: string
Parameter Order: name
HTTP Method: GET
▼ ▲ apigeeregistry.projects.locations.apis.versions.artifacts.testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:testIamPermissions
Parameter Order: resource
HTTP Method: POST
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Path: v1/{+resource}:testIamPermissions
Parameters:
resource
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.replaceArtifact
Parameter Order: name
HTTP Method: PUT
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Type: string
Description: Resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Location: path
Description: ReplaceArtifact can be used to replace a specified artifact.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.getContents
Parameter Order: name
Description: GetArtifactContents returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getContents
HTTP Method: GET
Path: v1/{+name}:getContents
Parameters:
name
Required: Yes
Type: string
Description: Required. The name of the artifact whose contents should be retrieved. Format: {parent}/artifacts/*
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Location: path
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Location: query
Description: A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
Type: string
pageSize
Type: integer
Description: The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Format: int32
Location: query
filter
Type: string
Location: query
Description: An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type: string
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
Parameter Order: parent
HTTP Method: GET
Path: v1/{+parent}/artifacts
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts
Description: ListArtifacts returns matching artifacts.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}
HTTP Method: GET
Path: v1/{+name}
Description: GetArtifact returns a specified artifact.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The name of the artifact to retrieve. Format: {parent}/artifacts/*
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.create
Description: CreateArtifact creates a specified artifact.
Path: v1/{+parent}/artifacts
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
Location: path
Required: Yes
Type: string
artifactId
Location: query
Description: Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts
HTTP Method: POST
Parameter Order: parent
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.setIamPolicy
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path: v1/{+resource}:setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Type: string
Location: path
Required: Yes
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getIamPolicy
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Location: path
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options.requestedPolicyVersion
Location: query
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Type: string
Location: path
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
HTTP Method: POST
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.artifacts.delete
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Description: Required. The name of the artifact to delete. Format: {parent}/artifacts/*
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}
HTTP Method: DELETE
Description: DeleteArtifact removes a specified artifact.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.delete
Parameter Order: name
Description: DeleteApiSpec removes a specified spec, all revisions, and all child resources (e.g. artifacts).
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}
Path: v1/{+name}
HTTP Method: DELETE
Parameters:
force
Type: boolean
Location: query
Description: If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Location: path
Description: Required. The name of the spec to delete. Format: projects/*/locations/*/apis/*/versions/*/specs/*
Required: Yes
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.rollback
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:rollback
HTTP Method: POST
Path: v1/{+name}:rollback
Parameters:
name
Required: Yes
Description: Required. The spec being rolled back.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Description: RollbackApiSpec sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.getContents
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getContents
Description: GetApiSpecContents returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:getContents
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Description: Required. The name of the spec whose contents should be retrieved. Format: projects/*/locations/*/apis/*/versions/*/specs/*
Required: Yes
Location: path
Parameter Order: name
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.patch
Parameter Order: name
Path: v1/{+name}
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}
Description: UpdateApiSpec can be used to modify a specified spec.
Parameters:
allowMissing
Type: boolean
Location: query
Description: If set to true, and the spec is not found, a new spec will be created. In this situation, `update_mask` is ignored.
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Type: string
Required: Yes
Description: Resource name.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location: query
Type: integer
Format: int32
resource
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Location: path
Required: Yes
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getIamPolicy
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.setIamPolicy
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:setIamPolicy
Parameters:
resource
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Required: Yes
Location: path
Parameter Order: resource
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.deleteRevision
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example: projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Location: path
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:deleteRevision
Parameter Order: name
Description: DeleteApiSpecRevision deletes a revision of a spec.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:deleteRevision
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.listRevisions
HTTP Method: GET
Path: v1/{+name}:listRevisions
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: ListApiSpecRevisions lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:listRevisions
Parameter Order: name
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Required: Yes
Location: path
Description: Required. The name of the spec to list revisions for.
pageSize
Type: integer
Description: The maximum number of revisions to return per page.
Format: int32
Location: query
pageToken
Description: The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page.
Type: string
Location: query
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.list
Path: v1/{+parent}/specs
Description: ListApiSpecs returns matching specs.
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs
Parameters:
pageToken
Description: A page token, received from a previous `ListApiSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiSpecs` must match the call that provided the page token.
Location: query
Type: string
filter
Location: query
Description: An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Type: string
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Type: string
Description: Required. The parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*
Location: path
pageSize
Location: query
Type: integer
Description: The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Format: int32
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Required: Yes
Location: path
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Type: string
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:testIamPermissions
Parameter Order: resource
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.get
Parameters:
name
Description: Required. The name of the spec to retrieve. Format: projects/*/locations/*/apis/*/versions/*/specs/*
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: GetApiSpec returns a specified spec.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}
Path: v1/{+name}
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs
Parameters:
apiSpecId
Type: string
Location: query
Description: Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$
Description: Required. The parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*
Type: string
Location: path
Required: Yes
Description: CreateApiSpec creates a specified spec.
Path: v1/{+parent}/specs
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ apigeeregistry.projects.locations.apis.versions.specs.tagRevision
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: TagApiSpecRevision adds a tag to a specified revision of a spec.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:tagRevision
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$
Required: Yes
Description: Required. The name of the spec to be tagged, including the revision ID.
Location: path
Type: string
Path: v1/{+name}:tagRevision
▼ ▲ apigeeregistry.projects.locations.apis.deployments.rollback
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:rollback
Parameters:
name
Location: path
Description: Required. The deployment being rolled back.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: RollbackApiDeployment sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.
Path: v1/{+name}:rollback
▼ ▲ apigeeregistry.projects.locations.apis.deployments.deleteRevision
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:deleteRevision
Path: v1/{+name}:deleteRevision
Parameters:
name
Description: Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example: projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Description: DeleteApiDeploymentRevision deletes a revision of a deployment.
▼ ▲ apigeeregistry.projects.locations.apis.deployments.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments
Parameter Order: parent
Path: v1/{+parent}/deployments
Description: ListApiDeployments returns matching deployments.
Parameters:
filter
Description: An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
Type: string
Location: query
pageToken
Type: string
Description: A page token, received from a previous `ListApiDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiDeployments` must match the call that provided the page token.
Location: query
pageSize
Format: int32
Location: query
Type: integer
Description: The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Required: Yes
Description: Required. The parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/*
Type: string
HTTP Method: GET
▼ ▲ apigeeregistry.projects.locations.apis.deployments.create
Parameters:
apiDeploymentId
Description: Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Location: query
Type: string
parent
Location: path
Required: Yes
Description: Required. The parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/*
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type: string
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments
Description: CreateApiDeployment creates a specified deployment.
HTTP Method: POST
Path: v1/{+parent}/deployments
▼ ▲ apigeeregistry.projects.locations.apis.deployments.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Location: path
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
Location: query
Type: integer
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:getIamPolicy
Parameter Order: resource
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Path: v1/{+resource}:getIamPolicy
HTTP Method: GET
▼ ▲ apigeeregistry.projects.locations.apis.deployments.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: GetApiDeployment returns a specified deployment.
HTTP Method: GET
Path: v1/{+name}
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Description: Required. The name of the deployment to retrieve. Format: projects/*/locations/*/apis/*/deployments/*
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}
Parameter Order: name
▼ ▲ apigeeregistry.projects.locations.apis.deployments.delete
HTTP Method: DELETE
Path: v1/{+name}
Parameters:
force
Type: boolean
Location: query
Description: If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
name
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Description: Required. The name of the deployment to delete. Format: projects/*/locations/*/apis/*/deployments/*
Type: string
Location: path
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}
Description: DeleteApiDeployment removes a specified deployment, all revisions, and all child resources (e.g. artifacts).
▼ ▲ apigeeregistry.projects.locations.apis.deployments.patch
Description: UpdateApiDeployment can be used to modify a specified deployment.
Parameters:
allowMissing
Location: query
Type: boolean
Description: If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored.
updateMask
Format: google-fieldmask
Description: The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
Type: string
Location: query
name
Description: Resource name.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Required: Yes
Location: path
Path: v1/{+name}
HTTP Method: PATCH
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}
▼ ▲ apigeeregistry.projects.locations.apis.deployments.setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path: v1/{+resource}:setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:setIamPolicy
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Type: string
Location: path
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Parameter Order: resource
▼ ▲ apigeeregistry.projects.locations.apis.deployments.testIamPermissions
Parameters:
resource
Required: Yes
Type: string
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Parameter Order: resource
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Path: v1/{+resource}:testIamPermissions
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:testIamPermissions
▼ ▲ apigeeregistry.projects.locations.apis.deployments.tagRevision
Description: TagApiDeploymentRevision adds a tag to a specified revision of a deployment.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:tagRevision
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:tagRevision
Parameter Order: name
Parameters:
name
Location: path
Type: string
Description: Required. The name of the deployment to be tagged, including the revision ID.
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Required: Yes
HTTP Method: POST
▼ ▲ apigeeregistry.projects.locations.apis.deployments.listRevisions
Description: ListApiDeploymentRevisions lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:listRevisions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Description: The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page.
Type: string
Location: query
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Required: Yes
Description: Required. The name of the deployment to list revisions for.
pageSize
Description: The maximum number of revisions to return per page.
Format: int32
Type: integer
Location: query
Parameter Order: name
Path: v1/{+name}:listRevisions
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts
Parameter Order: parent
Description: ListArtifacts returns matching artifacts.
Parameters:
filter
Description: An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Location: query
Type: string
pageSize
Location: query
Description: The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Format: int32
Type: integer
parent
Location: path
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Type: string
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
HTTP Method: GET
Path: v1/{+parent}/artifacts
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.getContents
Path: v1/{+name}:getContents
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}:getContents
Description: GetArtifactContents returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The name of the artifact whose contents should be retrieved. Format: {parent}/artifacts/*
HTTP Method: GET
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.replaceArtifact
Path: v1/{+name}
HTTP Method: PUT
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: ReplaceArtifact can be used to replace a specified artifact.
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$
Description: Resource name.
Required: Yes
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}
Description: DeleteArtifact removes a specified artifact.
HTTP Method: DELETE
Path: v1/{+name}
Parameters:
name
Type: string
Location: path
Description: Required. The name of the artifact to delete. Format: {parent}/artifacts/*
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.get
Description: GetArtifact returns a specified artifact.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Required: Yes
Description: Required. The name of the artifact to retrieve. Format: {parent}/artifacts/*
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$
Type: string
HTTP Method: GET
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}
Path: v1/{+name}
▼ ▲ apigeeregistry.projects.locations.apis.deployments.artifacts.create
Parameters:
parent
Type: string
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$
Location: path
artifactId
Location: query
Description: Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST
Path: v1/{+parent}/artifacts
Description: CreateArtifact creates a specified artifact.
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Description: DeleteArtifact removes a specified artifact.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}
Parameter Order: name
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Description: Required. The name of the artifact to delete. Format: {parent}/artifacts/*
Location: path
HTTP Method: DELETE
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.getContents
Parameters:
name
Description: Required. The name of the artifact whose contents should be retrieved. Format: {parent}/artifacts/*
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
HTTP Method: GET
Path: v1/{+name}:getContents
Description: GetArtifactContents returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getContents
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.setIamPolicy
HTTP Method: POST
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Location: path
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Type: string
Required: Yes
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:setIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:setIamPolicy
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.testIamPermissions
Parameter Order: resource
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Type: string
Required: Yes
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Location: path
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
HTTP Method: GET
Description: GetArtifact returns a specified artifact.
Parameters:
name
Required: Yes
Type: string
Location: path
Description: Required. The name of the artifact to retrieve. Format: {parent}/artifacts/*
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Parameter Order: name
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.create
Parameter Order: parent
HTTP Method: POST
Description: CreateArtifact creates a specified artifact.
Path: v1/{+parent}/artifacts
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts
Parameters:
artifactId
Description: Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Location: query
Type: string
parent
Required: Yes
Type: string
Location: path
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:getIamPolicy
HTTP Method: GET
Parameters:
resource
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Location: path
options.requestedPolicyVersion
Location: query
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
Format: int32
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.replaceArtifact
Path: v1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$
Required: Yes
Location: path
Type: string
Description: ReplaceArtifact can be used to replace a specified artifact.
HTTP Method: PUT
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}
▼ ▲ apigeeregistry.projects.locations.apis.artifacts.list
HTTP Method: GET
Parameters:
pageSize
Type: integer
Format: int32
Description: The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Location: query
filter
Location: query
Description: An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+/apis/[^/]+$
Type: string
Required: Yes
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
Location: path
pageToken
Location: query
Description: A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: ListArtifacts returns matching artifacts.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts
Path: v1/{+parent}/artifacts
Parameter Order: parent
▼ ▲ apigeeregistry.projects.locations.artifacts.testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:testIamPermissions
Parameters:
resource
Type: string
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Parameter Order: resource
HTTP Method: POST
▼ ▲ apigeeregistry.projects.locations.artifacts.getContents
Parameters:
name
Description: Required. The name of the artifact whose contents should be retrieved. Format: {parent}/artifacts/*
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:getContents
Description: GetArtifactContents returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).
HTTP Method: GET
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getContents
▼ ▲ apigeeregistry.projects.locations.artifacts.create
Path: v1/{+parent}/artifacts
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/artifacts
Parameters:
parent
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
artifactId
Location: query
Description: Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: CreateArtifact creates a specified artifact.
HTTP Method: POST
▼ ▲ apigeeregistry.projects.locations.artifacts.list
HTTP Method: GET
Parameters:
pageSize
Format: int32
Type: integer
Description: The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
Location: query
parent
Location: path
Description: Required. The parent, which owns this collection of artifacts. Format: {parent}
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
filter
Type: string
Location: query
Description: An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
pageToken
Type: string
Description: A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/artifacts
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/artifacts
Parameter Order: parent
Description: ListArtifacts returns matching artifacts.
▼ ▲ apigeeregistry.projects.locations.artifacts.replaceArtifact
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PUT
Description: ReplaceArtifact can be used to replace a specified artifact.
Path: v1/{+name}
Parameters:
name
Type: string
Description: Resource name.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Required: Yes
▼ ▲ apigeeregistry.projects.locations.artifacts.setIamPolicy
Parameters:
resource
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:setIamPolicy
HTTP Method: POST
Path: v1/{+resource}:setIamPolicy
Parameter Order: resource
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ apigeeregistry.projects.locations.artifacts.getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:getIamPolicy
HTTP Method: GET
Parameter Order: resource
Parameters:
options.requestedPolicyVersion
Location: query
Type: integer
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Pattern: ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Location: path
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getIamPolicy
▼ ▲ apigeeregistry.projects.locations.artifacts.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+name}
Description: GetArtifact returns a specified artifact.
Parameters:
name
Required: Yes
Description: Required. The name of the artifact to retrieve. Format: {parent}/artifacts/*
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}
Parameter Order: name
▼ ▲ apigeeregistry.projects.locations.artifacts.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}
Description: DeleteArtifact removes a specified artifact.
Path: v1/{+name}
HTTP Method: DELETE
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$
Location: path
Description: Required. The name of the artifact to delete. Format: {parent}/artifacts/*
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name