Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Send Requests
• Security, Authentication, and Authorization
• Status Codes
• Use cURL

Tasks

• APIs
  • Create an API
  • Delete an API
  • Get an API resource
  • Get an API's references
  • Get API details
  • Get APIs
  • Get applications a user can reference
  • Get gateways a user can reference
  • Get service accounts a user can reference
  • Get services a user can reference
  • Update an API
  • Update an API's publication state
  • Update an API's state
  • Update API identity
  • Validate a Policy
  • Grants
    • Get API grants
    • Get eligible grantees
    • Get grants issued for an API
    • Issue an API grant
    • Revoke an API grant from a group
    • Revoke an API grant from a user
  • Iterations
    • Get an API iteration resource
    • Get an API iteration's references
    • Get API iteration details
    • Return the Apiary project
• Applications
  • Create an application
  • Delete an application
  • Get application types
  • Get Applications
  • Update an application
  • View application details
  • Grants
    • Get application grants
    • Get eligible grantees
    • Get grants issued for an application
    • Issue an application grant
    • Revoke an application grant from a group
    • Revoke an application grant from a user
  • Key
    • Update application key
• Deployments
  • APIs
    • Approve or reject a deployment request
    • Cancel or delete a deployment
    • Deploy or request deployment of an API
    • Get API deployments
    • Get gateways an API can be deployed to
    • Get references of deployed API
    • View deployed API definition
    • View deployment details
  • Gateways
    • Approve or reject a deployment request
    • Cancel or delete a deployment
    • Deploy or request deployment of an API
    • Get APIs that can be deployed to a gateway
    • Get deployed APIs
    • Get references of deployed API
    • View deployed API definition
    • View deployment details
• Entitlements
  • APIs
    • Add an API
    • Delete an entitlement
    • Get available plans for an API
    • Get entitlement details
    • Get entitlements
    • Update an entitlement
    • Update entitlement publication
    • Update entitlement state
  • Plans
    • Add an API
    • Delete a entitlement
    • Get APIs eligible for a plan
    • Get entitlement details
    • Get entitlements
    • Update entitlement of a plan
    • Update entitlement publication
    • Update entitlement state
• Gateways
  • Change a gateway's name
  • Create a gateway
  • Delete a gateway
  • Generate Gateway Node Install Properties template
  • Get gateway details
  • Get gateways
  • Update a gateway
  • Grants
    • Get eligible grantees
    • Get gateway grants
    • Get grants issued for a gateway
    • Issue a gateway grant
    • Revoke a gateway grant from a group
    • Revoke a gateway grant from a user
  • Nodes
    • Get gateway nodes
    • Register a node to a gateway
    • Unregister a gateway node
    • Update a gateway node
    • Update a gateway node state
    • View gateway node details
• Plans
  • Create a plan
  • Delete a plan
  • Get a Plan resource
  • Get Gateways a user can reference
  • Get plans
  • Get References for Plan
  • Update a plan
  • Update a Plan's publication state
  • Update a Plan's state
  • Update Plan Identity
  • View plan details
  • Grants
    • Get eligible grantees
    • Get grants issued for a plan
    • Get plan grants
    • Issue plan grants
    • Revoke a plan grant from a group
    • Revoke a plan grant from a user
• Policies
  • Get metadata for all policies
  • Get policy resource
  • Get policy types
  • View policy metadata
• Service Accounts
  • Create a Service Account
  • Delete a Service Account
  • Get Service Account details
  • Get Service Accounts
  • Update a Service Account
  • Update Service Account Identity
  • Grants
    • Get eligible grantees
    • Get grants issued for a service account
    • Get service account grants
    • Issue service account grants
    • Revoke a service account grant from a group
    • Revoke a service account grant from a user
• Services
  • Create a Service
  • Delete a Service
  • Get a Service resource
  • Get References for Service
  • Get Service Accounts a user can reference
  • Get Service details
  • Get Services
  • Update a Service
  • Update a Service's state
  • Update Service Identity
  • Grants
    • Get eligible grantees
    • Get grants issued for a service
    • Get service grants
    • Issue service grants
    • Revoke a service grant from a group
    • Revoke a service grant from a user
• Subscriptions
  • Applications
    • Delete a subscription
    • Get available plans for an application
    • Get subscription details
    • Get subscriptions
    • Subscribe to an application
    • Update subscription state
  • Plans
    • Delete a subscription
    • Get applications eligible for a plan
    • Get subscription details
    • Get subscriptions
    • Subscribe to an application
    • Update subscription state