Google

Apigee API

Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy…

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.

Endpoints 134

organizations.spaces

  • GETGet a space under an Organization./v1/:nameGet a space under an Organization.
  • DELETEDeletes an organization space./v1/:nameDeletes an organization space.
  • PATCHUpdates a space./v1/:name?updateMask=stringUpdates a space.
  • GETCallers must have apigee.spaces.getIamPolicy./v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Callers must have apigee.spaces.getIamPolicy.
  • POSTIAM META APIs Callers must have apigee.spaces.setIamPolicy./v1/:resource:setIamPolicyIAM META APIs Callers must have apigee.spaces.setIamPolicy.
  • POSTCallers don't need any permissions./v1/:resource:testIamPermissionsCallers don't need any permissions.
  • GETLists spaces under an organization./v1/:parent/spaces?pageSize=0&pageToken=stringLists spaces under an organization.
  • POSTCreate a space under an organization./v1/:parent/spaces?spaceId=stringCreate a space under an organization.

organizations.sites.apidocs

  • PUTUpdates a catalog item./v1/:nameUpdates a catalog item.
  • GETReturns the catalog items associated with a portal./v1/:parent/apidocs?pageSize=0&pageToken=stringReturns the catalog items associated with a portal.
  • POSTCreates a new catalog item./v1/:parent/apidocsCreates a new catalog item.

organizations.sharedflows.revisions

  • POSTUpdates a shared flow revision/v1/:name?validate=trueUpdates a shared flow revision. This operation is only allowed on revisions which have never been deployed. After deployment a revision becomes immutable,…

organizations

  • POSTCreates an Apigee organization/v1/organizations?parent=stringCreates an Apigee organization. See Create an Apigee organization.
  • GETGets the project ID and region for an Apigee organization./v1/:name:getProjectMappingGets the project ID and region for an Apigee organization.
  • POSTLists the service accounts with the permissions required to allow the Synchronizer to download environment data from…/v1/:name:getSyncAuthorizationLists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in…
  • GETLists the Apigee organizations and associated Google Cloud projects that you have permission to access/v1/:parentLists the Apigee organizations and associated Google Cloud projects that you have permission to access. See Understanding organizations.
  • POSTConfigures the add-ons for the Apigee organization/v1/:org:setAddonsConfigures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced.
  • POSTSets the permissions required to allow the Synchronizer to download environment data from the control plane/v1/:name:setSyncAuthorizationSets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper…

organizations.analytics.datastores

  • GETList Datastores/v1/:parent/analytics/datastores?targetType=stringList Datastores
  • POSTCreate a Datastore for an org/v1/:parent/analytics/datastoresCreate a Datastore for an org
  • POSTTest if Datastore configuration is correct/v1/:parent/analytics/datastores:testTest if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage

organizations.apimServiceExtensions

  • GETLists all APIM service extensions in an organization./v1/:parent/apimServiceExtensions?pageSize=0&pageToken=stringLists all APIM service extensions in an organization.
  • POSTCreates an APIM ServiceExtension in an organization./v1/:parent/apimServiceExtensions?apimServiceExtensionId=stringCreates an APIM ServiceExtension in an organization.

organizations.developers.apps

  • POSTUpdates attributes for a developer app/v1/:name/attributesUpdates attributes for a developer app. This API replaces the current attributes with those specified in the request.
  • GETLists all apps created by a developer in an Apigee organization/v1/:parent/apps?count=string&expand=true&shallowExpand=true&startKey=stringLists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100…
  • POSTCreates an app associated with a developer/v1/:parent/appsCreates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to…

organizations.apiproducts

  • GETLists all API product names for an organization/v1/:parent/apiproducts?attributename=string&attributevalue=string&count=string&expand=true&space=string&startKey=stringLists all API product names for an organization. Filter the list by passing an attributename and attibutevalue. The maximum number of API products returned is…
  • POSTCreates an API product in an organization/v1/:parent/apiproductsCreates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection…

organizations.sharedflows

  • POSTMoves an shared flow to a different space./v1/:name:moveMoves an shared flow to a different space.
  • GETLists all shared flows in the organization/v1/:parent/sharedflows?includeMetaData=true&includeRevisions=true&space=stringLists all shared flows in the organization. If the resource has the space attribute set, the response may not return all resources. To learn more, read the…
  • POSTUploads a ZIP-formatted shared flow configuration bundle to an organization/v1/:parent/sharedflows?action=string&name=string&space=stringUploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the…

organizations.developers.attributes

  • GETReturns a list of all developer attributes./v1/:parent/attributesReturns a list of all developer attributes.

organizations.developers

  • POSTUpdates developer attributes/v1/:parent/attributesUpdates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any…
  • GETLists all developers in an organization by email address/v1/:parent/developers?app=string&count=string&expand=true&ids=string&includeCompany=true&startKey=stringLists all developers in an organization by email address. By default, the response does not include company developers. Set the includeCompany query parameter…
  • POSTCreates a developer/v1/:parent/developersCreates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as active. To change the…

organizations.apiproducts.rateplans

  • GETLists all the rate plans for an API product./v1/:parent/rateplans?count=0&expand=true&orderBy=string&startKey=string&state=STATE_UNSPECIFIEDLists all the rate plans for an API product.
  • POSTCreate a rate plan that is associated with an API product in an organization/v1/:parent/rateplansCreate a rate plan that is associated with an API product in an organization. Using rate plans, API product owners can monetize their API products by…

organizations.apis

  • GETLists the names of all API proxies in an organization/v1/:parent/apis?includeMetaData=true&includeRevisions=true&space=stringLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If…
  • POSTCreates an API proxy/v1/:parent/apis?action=string&name=string&space=string&validate=trueCreates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the…

organizations.environments.apis.revisions.debugsessions

  • GETLists debug sessions that are currently active in the given API Proxy revision./v1/:parent/debugsessions?pageSize=0&pageToken=stringLists debug sessions that are currently active in the given API Proxy revision.
  • POSTCreates a debug session for a deployed API Proxy revision./v1/:parent/debugsessions?timeout=stringCreates a debug session for a deployed API Proxy revision.
  • DELETEDeletes the data from a debug session/v1/:name/dataDeletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in…

organizations.sharedflows.revisions.deployments

  • GETLists all deployments of a shared flow revision./v1/:parent/deploymentsLists all deployments of a shared flow revision.

organizations.keyvaluemaps

  • POSTCreates a key value map in an organization./v1/:parent/keyvaluemapsCreates a key value map in an organization.

organizations.keyvaluemaps.entries

  • GETLists key value entries for key values maps scoped to an organization, environment, or API proxy/v1/:parent/entries?pageSize=0&pageToken=stringLists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
  • POSTCreates key value entries in a key value map scoped to an organization, environment, or API proxy/v1/:parent/entriesCreates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

organizations.appgroups

  • GETLists all AppGroups in an organization/v1/:parent/appgroups?filter=string&pageSize=0&pageToken=stringLists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater…
  • POSTCreates an AppGroup/v1/:parent/appgroupsCreates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set…

organizations.developers.apps.keys

  • POSTCreates a custom consumer key and secret for a developer app/v1/:parent/keysCreates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee…

organizations.developers.balance

  • POSTAdjust the prepaid balance for the developer/v1/:name:adjustAdjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged.
  • POSTCredits the account balance for the developer./v1/:name:creditCredits the account balance for the developer.

organizations.developers.subscriptions

  • GETLists all API product subscriptions for a developer./v1/:parent/subscriptions?count=0&startKey=stringLists all API product subscriptions for a developer.
  • POSTCreates a subscription to an API product/v1/:parent/subscriptionsCreates a subscription to an API product.
  • POSTExpires an API product subscription immediately./v1/:name:expireExpires an API product subscription immediately.

organizations.datacollectors

  • GETLists all data collectors./v1/:parent/datacollectors?pageSize=0&pageToken=stringLists all data collectors.
  • POSTCreates a new data collector./v1/:parent/datacollectors?dataCollectorId=stringCreates a new data collector.

organizations.developers.apps.keys.create

  • POSTCreates a custom consumer key and secret for a developer app/v1/:parent/keys/createCreates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee…

organizations.dnsZones

  • GETEnumerates DNS zones that have been created but not yet deleted./v1/:parent/dnsZones?pageSize=0&pageToken=stringEnumerates DNS zones that have been created but not yet deleted.
  • POSTCreates a new DNS zone./v1/:parent/dnsZones?dnsZoneId=stringCreates a new DNS zone.

organizations.endpointAttachments

  • GETLists the endpoint attachments in an organization./v1/:parent/endpointAttachments?pageSize=0&pageToken=stringLists the endpoint attachments in an organization.
  • POSTCreates an endpoint attachment/v1/:parent/endpointAttachments?endpointAttachmentId=stringCreates an endpoint attachment. Note: Not supported for Apigee hybrid.

organizations.envgroups

  • GETLists all environment groups./v1/:parent/envgroups?pageSize=0&pageToken=stringLists all environment groups.
  • POSTCreates a new environment group./v1/:parent/envgroups?name=stringCreates a new environment group.

organizations.instances.attachments

  • GETLists all attachments to an instance/v1/:parent/attachments?pageSize=0&pageToken=stringLists all attachments to an instance. Note: Not supported for Apigee hybrid.
  • POSTCreates a new attachment of an environment to an instance/v1/:parent/attachmentsCreates a new attachment of an environment to an instance. Note: Not supported for Apigee hybrid.

organizations.securityProfiles.environments

  • POSTCreateSecurityProfileEnvironmentAssociation creates profile environment association i.e/v1/:parent/environmentsCreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile.
  • POSTComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment./v1/:profileEnvironment:computeEnvironmentScoresComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment.

organizations.environments

  • POSTCreates a subscription for the environment's Pub/Sub topic/v1/:parent:subscribeCreates a subscription for the environment's Pub/Sub topic. The server will assign a random name for this subscription. The "name" and "push_config" must…
  • POSTDeletes a subscription for the environment's Pub/Sub topic./v1/:parent:unsubscribeDeletes a subscription for the environment's Pub/Sub topic.

organizations.environments.addonsConfig

  • POSTUpdates an add-on enablement status of an environment./v1/:name:setAddonEnablementUpdates an add-on enablement status of an environment.

organizations.environments.analytics.exports

  • GETLists the details and status of all analytics export jobs belonging to the parent organization and environment./v1/:parent/analytics/exportsLists the details and status of all analytics export jobs belonging to the parent organization and environment.
  • POSTSubmit a data export job to be processed in the background/v1/:parent/analytics/exportsSubmit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the…

organizations.environments.sharedflows.revisions

  • GETGets the deployment of a shared flow revision and actual state reported by runtime pods./v1/:name/deploymentsGets the deployment of a shared flow revision and actual state reported by runtime pods.
  • POSTDeploys a revision of a shared flow/v1/:name/deployments?override=true&serviceAccount=stringDeploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the override parameter to true to have this…
  • DELETEUndeploys a shared flow revision from an environment/v1/:name/deploymentsUndeploys a shared flow revision from an environment. For a request path organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments,…

organizations.environments.apis.revisions.deployments

  • POSTGenerates a report for a dry run analysis of a DeployApiProxy request without committing the deployment/v1/:name/deployments:generateDeployChangeReport?override=trueGenerates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed…
  • POSTGenerates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy/v1/:name/deployments:generateUndeployChangeReportGenerates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed…

organizations.environments.archiveDeployments

  • GETLists the ArchiveDeployments in the specified Environment./v1/:parent/archiveDeployments?filter=string&pageSize=0&pageToken=stringLists the ArchiveDeployments in the specified Environment.
  • POSTCreates a new ArchiveDeployment./v1/:parent/archiveDeploymentsCreates a new ArchiveDeployment.
  • POSTGenerates a signed URL for downloading the original zip file used to create an Archive Deployment/v1/:name:generateDownloadUrlGenerates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be…
  • POSTGenerates a signed URL for uploading an Archive zip file to Google Cloud Storage/v1/:parent/archiveDeployments:generateUploadUrlGenerates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to…

organizations.environments.keystores

  • POSTCreates a keystore or truststore/v1/:parent/keystores?name=stringCreates a keystore or truststore. - Keystore: Contains certificates and their associated keys. - Truststore: Contains trusted certificates used to validate a…

organizations.environments.keystores.aliases

  • POSTCreates an alias from a key/certificate pair/v1/:parent/aliases?_password=string&alias=string&format=string&ignoreExpiryValidation=true&ignoreNewlineValidation=trueCreates an alias from a key/certificate pair. The structure of the request is controlled by the format query parameter: - keycertfile - Separate PEM-encoded…
  • GETGenerates a PKCS #10 Certificate Signing Request for the private key in an alias./v1/:name/csrGenerates a PKCS #10 Certificate Signing Request for the private key in an alias.
  • GETGets the certificate from an alias in PEM-encoded form./v1/:name/certificateGets the certificate from an alias in PEM-encoded form.

organizations.environments.queries

  • GETReturn a list of Asynchronous Queries/v1/:parent/queries?dataset=string&from=string&inclQueriesWithoutReport=string&status=string&submittedBy=string&to=stringReturn a list of Asynchronous Queries
  • POSTSubmit a query to be processed in the background/v1/:parent/queriesSubmit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In…

organizations.environments.references

  • POSTCreates a Reference in the specified environment./v1/:parent/referencesCreates a Reference in the specified environment.

organizations.environments.resourcefiles

  • GETLists all resource files, optionally filtering by type/v1/:parent/resourcefiles?type=stringLists all resource files, optionally filtering by type. For more information about resource files, see Resource files.
  • POSTCreates a resource file/v1/:parent/resourcefiles?name=string&type=stringCreates a resource file. Specify the Content-Type as application/octet-stream or multipart/form-data. For more information about resource files, see Resource…
  • GETGets the contents of a resource file/v1/:parent/resourcefiles/:type/:nameGets the contents of a resource file. For more information about resource files, see Resource files.
  • PUTUpdates a resource file/v1/:parent/resourcefiles/:type/:nameUpdates a resource file. Specify the Content-Type as application/octet-stream or multipart/form-data. For more information about resource files, see Resource…
  • DELETEDeletes a resource file/v1/:parent/resourcefiles/:type/:nameDeletes a resource file. For more information about resource files, see Resource files.
  • GETLists all resource files, optionally filtering by type/v1/:parent/resourcefiles/:typeLists all resource files, optionally filtering by type. For more information about resource files, see Resource files.

organizations.environments.securityActions

  • GETReturns a list of SecurityActions/v1/:parent/securityActions?filter=string&pageSize=0&pageToken=stringReturns a list of SecurityActions. This returns both enabled and disabled actions.
  • POSTCreateSecurityAction creates a SecurityAction./v1/:parent/securityActions?securityActionId=stringCreateSecurityAction creates a SecurityAction.
  • POSTDisable a SecurityAction/v1/:name:disableDisable a SecurityAction. The state of the SecurityAction after disabling is DISABLED. DisableSecurityAction can be called on SecurityActions in the state…
  • POSTEnable a SecurityAction/v1/:name:enableEnable a SecurityAction. The state of the SecurityAction after enabling is ENABLED. EnableSecurityAction can be called on SecurityActions in the state…

organizations.environments.securityIncidents

  • POSTBatchUpdateSecurityIncident updates multiple existing security incidents./v1/:parent/securityIncidents:batchUpdateBatchUpdateSecurityIncident updates multiple existing security incidents.
  • GETListSecurityIncidents lists all the security incident associated with the environment./v1/:parent/securityIncidents?filter=string&pageSize=0&pageToken=stringListSecurityIncidents lists all the security incident associated with the environment.

organizations.environments.securityReports

  • GETReturn a list of Security Reports/v1/:parent/securityReports?dataset=string&from=string&pageSize=0&pageToken=string&status=string&submittedBy=string&to=stringReturn a list of Security Reports
  • POSTSubmit a report request to be processed in the background/v1/:parent/securityReportsSubmit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report…

organizations.environments.securityStats

  • POSTRetrieve security statistics as tabular rows./v1/:orgenv/securityStats:queryTabularStatsRetrieve security statistics as tabular rows.
  • POSTRetrieve security statistics as a collection of time series./v1/:orgenv/securityStats:queryTimeSeriesStatsRetrieve security statistics as a collection of time series.

organizations.environments.targetservers

  • POSTCreates a TargetServer in the specified environment./v1/:parent/targetservers?name=stringCreates a TargetServer in the specified environment.

organizations.environments.traceConfig.overrides

  • GETLists all of the distributed trace configuration overrides in an environment./v1/:parent/overrides?pageSize=0&pageToken=stringLists all of the distributed trace configuration overrides in an environment.
  • POSTCreates a trace configuration override/v1/:parent/overridesCreates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override.…

organizations.hostQueries

  • GETReturn a list of Asynchronous Queries at host level./v1/:parent/hostQueries?dataset=string&envgroupHostname=string&from=string&inclQueriesWithoutReport=string&status=string&submittedBy=string&to=stringReturn a list of Asynchronous Queries at host level.
  • POSTSubmit a query at host level to be processed in the background/v1/:parent/hostQueriesSubmit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to…

organizations.hostSecurityReports

  • GETReturn a list of Security Reports at host level./v1/:parent/hostSecurityReports?dataset=string&envgroupHostname=string&from=string&pageSize=0&pageToken=string&status=string&submittedBy=string&to=stringReturn a list of Security Reports at host level.
  • POSTSubmit a query at host level to be processed in the background/v1/:parent/hostSecurityReportsSubmit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to…

organizations.instances

  • GETLists all Apigee runtime instances for the organization/v1/:parent/instances?pageSize=0&pageToken=stringLists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid.
  • POSTCreates an Apigee runtime instance/v1/:parent/instancesCreates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee…
  • POSTReports the latest status for a runtime instance./v1/:instance:reportStatusReports the latest status for a runtime instance.

organizations.instances.canaryevaluations

  • POSTCreates a new canary evaluation for an organization./v1/:parent/canaryevaluationsCreates a new canary evaluation for an organization.

organizations.instances.natAddresses

  • POSTActivates the NAT address/v1/:name:activateActivates the NAT address. The Apigee instance can now use this for Internet egress traffic. Note: Not supported for Apigee hybrid.
  • GETLists the NAT addresses for an Apigee instance/v1/:parent/natAddresses?pageSize=0&pageToken=stringLists the NAT addresses for an Apigee instance. Note: Not supported for Apigee hybrid.
  • POSTCreates a NAT address/v1/:parent/natAddressesCreates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not…

organizations.operations

  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

organizations.reports

  • GETReturn a list of Custom Reports/v1/:parent/reports?expand=trueReturn a list of Custom Reports
  • POSTCreates a Custom Report for an Organization/v1/:parent/reportsCreates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards…

organizations.securityAssessmentResults

  • POSTCompute RAV2 security scores for a set of resources./v1/:name:batchComputeCompute RAV2 security scores for a set of resources.

organizations.securityFeedback

  • GETLists all feedback reports which have already been submitted./v1/:parent/securityFeedback?pageSize=0&pageToken=stringLists all feedback reports which have already been submitted.
  • POSTCreates a new report containing customer feedback./v1/:parent/securityFeedback?securityFeedbackId=stringCreates a new report containing customer feedback.

organizations.securityMonitoringConditions

  • GETList security monitoring conditions./v1/:parent/securityMonitoringConditions?filter=string&pageSize=0&pageToken=string&riskAssessmentType=RISK_ASSESSMENT_TYPE_UNSPECIFIEDList security monitoring conditions.
  • POSTCreate a security monitoring condition./v1/:parent/securityMonitoringConditions?securityMonitoringConditionId=stringCreate a security monitoring condition.

organizations.securityProfiles

  • GETListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles./v1/:parent/securityProfiles?pageSize=0&pageToken=stringListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.
  • POSTCreateSecurityProfile create a new custom security profile./v1/:parent/securityProfiles?securityProfileId=stringCreateSecurityProfile create a new custom security profile.
  • GETListSecurityProfileRevisions lists all the revisions of the security profile./v1/:name:listRevisions?pageSize=0&pageToken=stringListSecurityProfileRevisions lists all the revisions of the security profile.

organizations.securityProfilesV2

  • GETList security profiles v2./v1/:parent/securityProfilesV2?pageSize=0&pageToken=string&riskAssessmentType=RISK_ASSESSMENT_TYPE_UNSPECIFIEDList security profiles v2.
  • POSTCreate a security profile v2./v1/:parent/securityProfilesV2?securityProfileV2Id=stringCreate a security profile v2.

organizations.sites.apicategories

  • GETReturns the API categories associated with a portal./v1/:parent/apicategoriesReturns the API categories associated with a portal.
  • POSTCreates a new API category./v1/:parent/apicategoriesCreates a new API category.

projects

  • POSTProvisions a new Apigee organization with a functioning runtime/v1/:project:provisionOrganizationProvisions a new Apigee organization with a functioning runtime. This is the standard way to create trial organizations for a free Apigee trial.

API details

Base URL
https://apigee.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
134 operations on 89 pathsPOST 77GET 50DELETE 4PUT 2PATCH 1
Main resources
organizations.spaces 8organizations 6organizations.environments.resourcefiles 6organizations.environments.archiveDeployments 4organizations.environments.securityActions 4organizations.analytics.datastores 3organizations.developers 3organizations.developers.apps 3organizations.developers.subscriptions 3organizations.environments.apis.revisions.debugsessions 3
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Apigee API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Apigee API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get a space under an Organization.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Apigee API?

Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy… It is listed under Developer tools and has 134 endpoints.

Who publishes the Apigee API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Apigee API?

Requests go to https://apigee.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Apigee API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Apigee API have?

134 operations on 89 paths (77 POST, 50 GET, 4 DELETE, 2 PUT, 1 PATCH). The largest groups are organizations.spaces, organizations, organizations.environments.resourcefiles, organizations.environments.archiveDeployments.

Is forking the Apigee API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.