REST API for the Management Service in Oracle API Platform Cloud Service

All REST Endpoints

APIs

View details about and manage APIs.

Compact an API: Method: post
Path: /apiplatform/management/v1/apis/{apiId}/compact
Create an API: Method: post
Path: /apiplatform/management/v1/apis
Delete an API: Method: delete
Path: /apiplatform/management/v1/apis/{apiId}
Get an API resource: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/resources/{pathname}
Get an API's references: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/references
Get API details: Method: get
Path: /apiplatform/management/v1/apis/{apiId}
Get APIs: Method: get
Path: /apiplatform/management/v1/apis
Get applications a user can reference: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/references/applications
Get gateways a user can reference: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/references/gateways
Get service accounts a user can reference: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/references/serviceaccounts
Get services a user can reference: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/references/services
Update an API: Method: put
Path: /apiplatform/management/v1/apis/{apiId}
Update an API's publication state: Method: put
Path: /apiplatform/management/v1/apis/{apiId}/publication
Update an API's state: Method: put
Path: /apiplatform/management/v1/apis/{apiId}/state
Update API identity: Method: put
Path: /apiplatform/management/v1/apis/{apiId}/identity
Validate a Policy: Method: post
Path: /apiplatform/management/v1/apis/{apiId}/validation

APIs/Grants

View details about and manage API grants.

Get API grants: Method: get
Path: /apiplatform/management/v1/apis/grants/types
Get eligible grantees: Method: get
Path: /apiplatform/management/v1/apis/grants/{grantType}/grantees
Get grants issued for an API: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/grants
Issue an API grant: Method: post
Path: /apiplatform/management/v1/apis/{apiId}/grants
Revoke an API grant from a group: Method: delete
Path: /apiplatform/management/v1/apis/{apiId}/grants/{grantType}/groups/{groupId}
Revoke an API grant from a user: Method: delete
Path: /apiplatform/management/v1/apis/{apiId}/grants/{grantType}/users/{userId}

APIs/Iterations

View details about and manage API iterations.

Get an API iteration resource: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/iterations/{iterId}/resources/{pathname}
Get an API iteration's references: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/iterations/{iterId}/references
Get API iteration details: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/iterations/{iterId}
Return the Apiary project: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/iterations/{iterId}/apiary

Applications

View details about and manage applications.

Create an application: Method: post
Path: /apiplatform/management/v1/applications
Delete an application: Method: delete
Path: /apiplatform/management/v1/applications/{appId}
Get application types: Method: get
Path: /apiplatform/management/v1/applications/types
Get Applications: Method: get
Path: /apiplatform/management/v1/applications
Update an application: Method: put
Path: /apiplatform/management/v1/applications/{appId}
View application details: Method: get
Path: /apiplatform/management/v1/applications/{appId}

Applications/Grants

View details about and manage application grants.

Get application grants: Method: get
Path: /apiplatform/management/v1/applications/grants/types
Get eligible grantees: Method: get
Path: /apiplatform/management/v1/applications/grants/{grantType}/grantees
Get grants issued for an application: Method: get
Path: /apiplatform/management/v1/applications/{appId}/grants
Issue an application grant: Method: post
Path: /apiplatform/management/v1/applications/{appId}/grants
Revoke an application grant from a group: Method: delete
Path: /apiplatform/management/v1/applications/{appId}/grants/{grantType}/groups/{groupId}
Revoke an application grant from a user: Method: delete
Path: /apiplatform/management/v1/applications/{appId}/grants/{grantType}/users/{userId}

Applications/Key

Update an application's key.

Update application key: Method: put
Path: /apiplatform/management/v1/applications/{appId}/key

Deployments/APIs

View details about and manage API deployments.

Approve or reject a deployment request: Method: put
Path: /apiplatform/management/v1/apis/{apiId}/deployments/{depId}/state
Cancel or delete a deployment: Method: delete
Path: /apiplatform/management/v1/apis/{apiId}/deployments/{depId}
Deploy or request deployment of an API: Method: post
Path: /apiplatform/management/v1/apis/{apiId}/deployments
Get API deployments: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/deployments
Get gateways an API can be deployed to: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/deployments/gateways
Get references of deployed API: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/deployments/{depId}/api/references
View deployed API definition: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/deployments/{depId}/api
View deployment details: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/deployments/{depId}

Deployments/Gateways

View details about and manage gateway deployments.

Approve or reject a deployment request: Method: put
Path: /apiplatform/management/v1/gateways/{gwId}/deployments/{depId}/state
Cancel or delete a deployment: Method: delete
Path: /apiplatform/management/v1/gateways/{gwId}/deployments/{depId}
Deploy or request deployment of an API: Method: post
Path: /apiplatform/management/v1/gateways/{gwId}/deployments
Get APIs that can be deployed to a gateway: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}/deployments/apis
Get deployed APIs: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}/deployments
Get references of deployed API: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}/deployments/{depId}/api/references
View deployed API definition: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}/deployments/{depId}/api
View deployment details: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}/deployments/{depId}

Entitlements/APIs

The operations from the Entitlements/APIs category.

Add an API: Method: post
Path: /apiplatform/management/v1/apis/{apiId}/entitlements
Delete an entitlement: Method: delete
Path: /apiplatform/management/v1/apis/{apiId}/entitlements/{entitlementId}
Get available plans for an API: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/entitlements/plans
Get entitlement details: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/entitlements/{entitlementId}
Get entitlements: Method: get
Path: /apiplatform/management/v1/apis/{apiId}/entitlements
Update an entitlement: Method: put
Path: /apiplatform/management/v1/apis/{apiId}/entitlements/{entitlementId}
Update entitlement publication: Method: put
Path: /apiplatform/management/v1/apis/{apiId}/entitlements/{entitlementId}/publication
Update entitlement state: Method: put
Path: /apiplatform/management/v1/apis/{apiId}/entitlements/{entitlementId}/state

Entitlements/Plans

The operations from the Entitlements/Plans category.

Add an API: Method: post
Path: /apiplatform/management/v1/plans/{planId}/entitlements
Delete a entitlement: Method: delete
Path: /apiplatform/management/v1/plans/{planId}/entitlements/{entitlementId}
Get APIs eligible for a plan: Method: get
Path: /apiplatform/management/v1/plans/{planId}/entitlements/apis
Get entitlement details: Method: get
Path: /apiplatform/management/v1/plans/{planId}/entitlements/{entitlementId}
Get entitlements: Method: get
Path: /apiplatform/management/v1/plans/{planId}/entitlements
Update entitlement of a plan: Method: put
Path: /apiplatform/management/v1/plans/{planId}/entitlements/{entitlementId}
Update entitlement publication: Method: put
Path: /apiplatform/management/v1/plans/{planId}/entitlements/{entitlementId}/publication
Update entitlement state: Method: put
Path: /apiplatform/management/v1/plans/{planId}/entitlements/{entitlementId}/state

Gateways

View details about and manage gateways.

Change a gateway's name: Method: put
Path: /apiplatform/management/v1/gateways/{gwId}/identity
Create a gateway: Method: post
Path: /apiplatform/management/v1/gateways
Delete a gateway: Method: delete
Path: /apiplatform/management/v1/gateways/{gwId}
Generate Gateway Node Install Properties template: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}/nodes/form
Get gateway details: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}
Get gateways: Method: get
Path: /apiplatform/management/v1/gateways
Update a gateway: Method: put
Path: /apiplatform/management/v1/gateways/{gwId}

Gateways/Grants

View details about and manage gateway grants.

Get eligible grantees: Method: get
Path: /apiplatform/management/v1/gateways/grants/{grantType}/grantees
Get gateway grants: Method: get
Path: /apiplatform/management/v1/gateways/grants/types
Get grants issued for a gateway: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}/grants
Issue a gateway grant: Method: post
Path: /apiplatform/management/v1/gateways/{gwId}/grants
Revoke a gateway grant from a group: Method: delete
Path: /apiplatform/management/v1/gateways/{gwId}/grants/{grantType}/groups/{groupId}
Revoke a gateway grant from a user: Method: delete
Path: /apiplatform/management/v1/gateways/{gwId}/grants/{grantType}/users/{userId}

Gateways/Nodes

View details about and manage gateway nodes.

Get gateway nodes: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}/nodes
Register a node to a gateway: Method: post
Path: /apiplatform/management/v1/gateways/{gwId}/nodes
Unregister a gateway node: Method: delete
Path: /apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}
Update a gateway node: Method: put
Path: /apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}
Update a gateway node state: Method: put
Path: /apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}/state
View gateway node details: Method: get
Path: /apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}

Plans

View details about plans.

Create a plan: Method: post
Path: /apiplatform/management/v1/plans
Delete a plan: Method: delete
Path: /apiplatform/management/v1/plans/{planId}
Get a Plan resource: Method: get
Path: /apiplatform/management/v1/plans/{planId}/resources/{pathname}
Get Gateways a user can reference: Method: get
Path: /apiplatform/management/v1/plans/{planId}/references/gateways
Get plans: Method: get
Path: /apiplatform/management/v1/plans
Get References for Plan: Method: get
Path: /apiplatform/management/v1/plans/{planId}/references
Update a plan: Method: put
Path: /apiplatform/management/v1/plans/{planId}
Update a Plan's publication state: Method: put
Path: /apiplatform/management/v1/plans/{planId}/publication
Update a Plan's state: Method: put
Path: /apiplatform/management/v1/plans/{planId}/state
Update Plan Identity: Method: put
Path: /apiplatform/management/v1/plans/{planId}/identity
View plan details: Method: get
Path: /apiplatform/management/v1/plans/{planId}

Plans/Grants

View details about and manage plan grants.

Get eligible grantees: Method: get
Path: /apiplatform/management/v1/plans/grants/{grantType}/grantees
Get grants issued for a plan: Method: get
Path: /apiplatform/management/v1/plans/{planId}/grants
Get plan grants: Method: get
Path: /apiplatform/management/v1/plans/grants/types
Issue plan grants: Method: post
Path: /apiplatform/management/v1/plans/{planId}/grants
Revoke a plan grant from a group: Method: delete
Path: /apiplatform/management/v1/plans/{planId}/grants/{grantType}/groups/{groupId}
Revoke a plan grant from a user: Method: delete
Path: /apiplatform/management/v1/plans/{planId}/grants/{grantType}/users/{userId}

Policies

View details about policies.

Get metadata for all policies: Method: get
Path: /apiplatform/management/v1/policies/metadata
Get policy resource: Method: get
Path: /apiplatform/management/v1/policies/{type}/{version}/resources/{pathname}
Get policy types: Method: get
Path: /apiplatform/management/v1/policies
View policy metadata: Method: get
Path: /apiplatform/management/v1/policies/{type}/{version}/metadata

Service Accounts

View details about and manage service accounts.

Create a Service Account: Method: post
Path: /apiplatform/management/v1/serviceaccounts
Delete a Service Account: Method: delete
Path: /apiplatform/management/v1/serviceaccounts/{saId}
Get Reference resources for a Service Account: Method: get
Path: /apiplatform/management/v1/serviceaccounts/{saId}/referencers
Get Service Account details: Method: get
Path: /apiplatform/management/v1/serviceaccounts/{saId}
Get Service Accounts: Method: get
Path: /apiplatform/management/v1/serviceaccounts
Update a Service Account: Method: put
Path: /apiplatform/management/v1/serviceaccounts/{saId}
Update Service Account Identity: Method: put
Path: /apiplatform/management/v1/serviceaccounts/{saId}/identity

Service Accounts/Grants

View details about and manage service account grants.

Get eligible grantees: Method: get
Path: /apiplatform/management/v1/serviceaccounts/grants/{grantType}/grantees
Get grants issued for a service account: Method: get
Path: /apiplatform/management/v1/serviceaccounts/{saId}/grants
Get service account grants: Method: get
Path: /apiplatform/management/v1/serviceaccounts/grants/types
Issue service account grants: Method: post
Path: /apiplatform/management/v1/serviceaccounts/{saId}/grants
Revoke a service account grant from a group: Method: delete
Path: /apiplatform/management/v1/serviceaccounts/{saId}/grants/{grantType}/groups/{groupId}
Revoke a service account grant from a user: Method: delete
Path: /apiplatform/management/v1/serviceaccounts/{saId}/grants/{grantType}/users/{userId}

Services

View details about and manage services.

Create a Service: Method: post
Path: /apiplatform/management/v1/services
Delete a Service: Method: delete
Path: /apiplatform/management/v1/services/{serviceId}
Get a Service resource: Method: get
Path: /apiplatform/management/v1/services/{serviceId}/resources/{pathname}
Get Reference resources for a Service: Method: get
Path: /apiplatform/management/v1/services/{serviceId}/referencers
Get References for Service: Method: get
Path: /apiplatform/management/v1/services/{serviceId}/references
Get Service Accounts a user can reference: Method: get
Path: /apiplatform/management/v1/services/{serviceId}/references/serviceaccounts
Get Service details: Method: get
Path: /apiplatform/management/v1/services/{serviceId}
Get Services: Method: get
Path: /apiplatform/management/v1/services
Update a Service: Method: put
Path: /apiplatform/management/v1/services/{serviceId}
Update a Service's state: Method: put
Path: /apiplatform/management/v1/services/{serviceId}/state
Update Service Identity: Method: put
Path: /apiplatform/management/v1/services/{serviceId}/identity

Services/Grants

The operations from the Services/Grants category.

Get eligible grantees: Method: get
Path: /apiplatform/management/v1/services/grants/{grantType}/grantees
Get grants issued for a service: Method: get
Path: /apiplatform/management/v1/services/{serviceId}/grants
Get service grants: Method: get
Path: /apiplatform/management/v1/services/grants/types
Issue service grants: Method: post
Path: /apiplatform/management/v1/services/{serviceId}/grants
Revoke a service grant from a group: Method: delete
Path: /apiplatform/management/v1/services/{serviceId}/grants/{grantType}/groups/{groupId}
Revoke a service grant from a user: Method: delete
Path: /apiplatform/management/v1/services/{serviceId}/grants/{grantType}/users/{userId}

Subscriptions/Applications

View details about and manage subscriptions to applications.

Delete a subscription: Method: delete
Path: /apiplatform/management/v1/applications/{appId}/subscriptions/{subId}
Get available plans for an application: Method: get
Path: /apiplatform/management/v1/applications/{appId}/subscriptions/plans
Get subscription details: Method: get
Path: /apiplatform/management/v1/applications/{appId}/subscriptions/{subId}
Get subscriptions: Method: get
Path: /apiplatform/management/v1/applications/{appId}/subscriptions
Subscribe to an application: Method: post
Path: /apiplatform/management/v1/applications/{appId}/subscriptions
Update subscription state: Method: put
Path: /apiplatform/management/v1/applications/{appId}/subscriptions/{subId}/state

Subscriptions/Plans

View details about and manage subscriptions to plans.

Delete a subscription: Method: delete
Path: /apiplatform/management/v1/plans/{planId}/subscriptions/{subId}
Get applications eligible for a plan: Method: get
Path: /apiplatform/management/v1/plans/{planId}/subscriptions/applications
Get subscription details: Method: get
Path: /apiplatform/management/v1/plans/{planId}/subscriptions/{subId}
Get subscriptions: Method: get
Path: /apiplatform/management/v1/plans/{planId}/subscriptions
Subscribe to an application: Method: post
Path: /apiplatform/management/v1/plans/{planId}/subscriptions
Update subscription state: Method: put
Path: /apiplatform/management/v1/plans/{planId}/subscriptions/{subId}/state