Apigee API (apigee:v1)

2025-03-10

11 new methods | 5 updated methods

Additions

    Methods
  • apigee.organizations.apiproducts.move

      Path : v1/{+name}:move

      Description : Moves an API product to a different space.

      HTTP Method : POST

      Parameter Order : name

      Flat Path : v1/organizations/{organizationsId}/apiproducts/{apiproductsId}:move

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Description : Required. API product to move in the following format: `organizations/{org}/apiproducts/{apiproduct}

          Type : string

          Location : path

          Pattern : ^organizations/[^/]+/apiproducts/[^/]+$

          Required : Yes

  • apigee.organizations.sharedflows.move

      HTTP Method : POST

      Flat Path : v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}:move

      Parameter Order : name

      Path : v1/{+name}:move

      Description : Moves an shared flow to a different space.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Description : Required. Shared Flow to move in the following format: `organizations/{org}/sharedflows/{shared_flow}`

          Type : string

          Location : path

          Pattern : ^organizations/[^/]+/sharedflows/[^/]+$

          Required : Yes

  • apigee.organizations.spaces.list

      Description : Lists spaces under an organization.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : parent

      Flat Path : v1/organizations/{organizationsId}/spaces

      Parameters :

        pageToken

          Type : string

          Location : query

          Description : Optional. A page token, received from a previous `ListSpaces` call. Provide this to retrieve the subsequent page. When paginating, all parameters must match the original call.

        parent

          Type : string

          Required : Yes

          Location : path

          Description : Required. Use the following structure in your request: `organizations`

          Pattern : ^organizations/[^/]+$

        pageSize

          Location : query

          Format : int32

          Type : integer

          Description : Optional. The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 50 spaces will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

      HTTP Method : GET

      Path : v1/{+parent}/spaces

  • apigee.organizations.spaces.get

      Parameters :

        name

          Pattern : ^organizations/[^/]+/spaces/[^/]+$

          Location : path

          Required : Yes

          Type : string

          Description : Required. Apigee organization space name in the following format: `organizations/{org}/spaces/{space}`

      Parameter Order : name

      Path : v1/{+name}

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Get a space under an Organization.

      Flat Path : v1/organizations/{organizationsId}/spaces/{spacesId}

  • apigee.organizations.spaces.testIamPermissions

      Parameter Order : resource

      Description : Callers don't need any permissions.

      Parameters :

        resource

          Type : string

          Location : path

          Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern : ^organizations/[^/]+/spaces/[^/]+$

          Required : Yes

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+resource}:testIamPermissions

      Flat Path : v1/organizations/{organizationsId}/spaces/{spacesId}:testIamPermissions

  • apigee.organizations.spaces.setIamPolicy

      Description : IAM META APIs Callers must have apigee.spaces.setIamPolicy.

      Parameters :

        resource

          Required : Yes

          Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type : string

          Location : path

          Pattern : ^organizations/[^/]+/spaces/[^/]+$

      Flat Path : v1/organizations/{organizationsId}/spaces/{spacesId}:setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : resource

  • apigee.organizations.spaces.create

      Parameters :

        parent

          Required : Yes

          Type : string

          Pattern : ^organizations/[^/]+$

          Description : Required. Name of the Google Cloud project in which to associate the Apigee space. Pass the information as a query parameter using the following structure in your request: `organizations/`

          Location : path

        spaceId

          Type : string

          Description : Required. Resource ID of the space.

          Location : query

      Flat Path : v1/organizations/{organizationsId}/spaces

      Parameter Order : parent

      Description : Create a space under an organization.

      Path : v1/{+parent}/spaces

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : POST

  • apigee.organizations.spaces.getIamPolicy

      Parameters :

        resource

          Location : path

          Type : string

          Required : Yes

          Pattern : ^organizations/[^/]+/spaces/[^/]+$

          Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) 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).

          Type : integer

          Location : query

          Format : int32

      Parameter Order : resource

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Callers must have apigee.spaces.getIamPolicy.

      Path : v1/{+resource}:getIamPolicy

      Flat Path : v1/organizations/{organizationsId}/spaces/{spacesId}:getIamPolicy

  • apigee.organizations.spaces.delete

      Path : v1/{+name}

      Parameters :

        name

          Location : path

          Description : Required. Apigee organization space name in the following format: `organizations/{org}/spaces/{space}`

          Pattern : ^organizations/[^/]+/spaces/[^/]+$

          Type : string

          Required : Yes

      Description : Deletes an organization space.

      Parameter Order : name

      Flat Path : v1/organizations/{organizationsId}/spaces/{spacesId}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : DELETE

  • apigee.organizations.spaces.patch

      Path : v1/{+name}

      Flat Path : v1/organizations/{organizationsId}/spaces/{spacesId}

      Parameters :

        updateMask

          Location : query

          Description : Required. List of fields to be updated. Fields that can be updated: display_name.

          Format : google-fieldmask

          Type : string

        name

          Type : string

          Pattern : ^organizations/[^/]+/spaces/[^/]+$

          Location : path

          Required : Yes

          Description : Required. Name of the space in the following format: `organizations/{org}/spaces/{space_id}`.

      Description : Updates a space.

      Parameter Order : name

      HTTP Method : PATCH

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • apigee.organizations.apis.move

      Flat Path : v1/organizations/{organizationsId}/apis/{apisId}:move

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+name}:move

      HTTP Method : POST

      Description : Moves an API proxy to a different space.

      Parameter Order : name

      Parameters :

        name

          Required : Yes

          Type : string

          Pattern : ^organizations/[^/]+/apis/[^/]+$

          Location : path

          Description : Required. API proxy to move in the following format: `organizations/{org}/apis/{api}`

Updates

    Methods
  • apigee.organizations.apiproducts.list

      Parameters :

        space

          Description : Optional. The Space to list API products for. When none provided, all the spaces the user has list access, will be used implicitly, and the same following rules will apply. Can be used in conjunction with start_key, expand and count for paginated response. Composite queries with attributename and attributevalue are not supported yet.

          Location : query

          Type : string

  • apigee.organizations.sharedflows.create

      Parameters :

        space

          Type : string

          Description : Optional. The ID of the space to associated with this shared flow. Any IAM policies applied to the space will affect access to this shared flow. Note that this field is only respected when creating a new shared flow. It has no effect when creating a new revision for an existing shared flow.

          Location : query

  • apigee.organizations.sharedflows.list

      Parameters :

        space

          Type : string

          Location : query

          Description : Optional. The space ID used to filter the list of shared flows (optional). If unspecified, all shared flows in the organization will be listed. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).

  • apigee.organizations.apis.create

      Parameters :

        space

          Location : query

          Description : Optional. The ID of the space associated with this proxy. Any IAM policies applied to the space will affect access to this proxy. Note that this field is only respected when creating a new proxy. It has no effect when creating a new revision for an existing proxy.

          Type : string

  • apigee.organizations.apis.list

      Parameters :

        space

          Location : query

          Type : string

          Description : Optional. The space ID to filter the list of proxies (optional). If unspecified, all proxies in the organization will be listed.