Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Acquia Codebases API

The Codebases API from Acquia — 8 operation(s) for codebases.

Acquia Codebases API is one of 21 APIs that Acquia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Codebases. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 8 paths. It is described by OpenAPI 3.0.0, at version 2.0.0.

12 operations 8 paths 0 schemas 1 DELETE8 GET1 OPTIONS1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Authentication
OAuth 2.0, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Acquia Codebases API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (Acquia_Cloud_API_Documentation_OAuth2) using the clientCredentials flow. An API key is passed in the header as Authorization (Codebase_Service_JWT). An API key is passed in the header as Authorization (MEO_Environment_Service_JWT). An API key is passed in the header as Authorization (Site_Service_JWT).

  • Acquia_Cloud_API_Documentation_OAuth2 — All Cloud API calls need to be authenticated in order to work. You authenticate using a token that you can generate on your Acquia Profile page. To generate a…
  • Codebase_Service_JWT — Value for the Authorization header parameter.
  • MEO_Environment_Service_JWT — Value for the Authorization header parameter.
  • Site_Service_JWT — Value for the Authorization header parameter.

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 1 DELETE, 8 GET, 1 OPTIONS, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Codebases 12
GET
/applications/{applicationId}/codebase
Acquia Retrieves a Codebase Details Linked to the Specified Application.
api_applications_applicationIdcodebase_get 1 param → 200403404
GET
/codebases
Acquia Retrieves a List of Codebases Accessible by the User.
api_codebases_get_collection → 200403404
DELETE
/codebases/{codebaseId}
Acquia Delete a Codebase by its ID.
api_codebases_codebaseId_delete 1 param → 202403404
GET
/codebases/{codebaseId}
Acquia Retrieves a Codebase Details by its ID.
get_codebase_by_id 1 param → 200403404
PUT
/codebases/{codebaseId}
Acquia Update a Codebase Details by its ID.
api_codebases_codebaseId_put 1 param body → 202400403404
GET
/codebases/{codebaseId}/bulk-code-switch
Acquia Retrieves a List of Bulk Code Switches Details Performed on a Codebase.
api_codebases_codebaseIdbulk-code-switch_get_collection 3 params → 200403404
POST
/codebases/{codebaseId}/bulk-code-switch
Acquia Starts a New Bulk Code Switch for a Codebase.
create_bulk_code_switch_resource 1 param body → 202400403404
GET
/codebases/{codebaseId}/bulk-code-switch/{bulkCodeSwitchId}
Acquia Retrieves Bulk Code Switch Details by Id.
get_bulk_code_switch_resource 2 params → 200403404
GET
/codebases/{codebaseId}/references
Acquia Retrieves a List of Git References by Codebase.
get_references_by_codebase 1 param → 200403404
GET
/codebases/{codebaseId}/references/{referenceName}
Acquia Retrieves a Single Git Reference Data for the Given Codebase.
get_single_reference 2 params → 200403404
GET
/subscriptions/{subscriptionId}/codebases
Acquia Retrieves a List of Codebases by Subscription ID.
subscription_codebases 1 param → 200403404
OPTIONS
/subscriptions/{subscriptionId}/codebases
Acquia Gets Supported Regions for a New Codebase.
api_subscriptions_subscriptionIdcodebases_options 1 param → 200403404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-codebases-api-openapi.yml Raw ↑

Other APIs Acquia publishes across the network.

Acquia Cloud Site Factory API
Acquia Content Hub API
Acquia Account API
Acquia Agreements API
Acquia Application Performance Monitoring Services API
Acquia Applications API
Acquia Cloud IDE API
Acquia Current system health API
Acquia Distributions API
Acquia Email API
Acquia Environments API
Acquia Identity Providers API