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 Agreements API

The Agreements API from Acquia — 5 operation(s) for agreements.

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

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

This API exposes 5 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

5 operations 5 paths 8 schemas 3 GET2 POST

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 Agreements 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 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Agreements 5
GET
/agreements
Acquia Return a List of Agreements.
getAgreements → 200404
GET
/agreements/{agreementUuid}
Acquia Return a Specific Agreement by a Provided UUID.
getAgreement 1 param → 200404
POST
/agreements/{agreementUuid}/actions/accept
Acquia Accepts a Legal Agreement by UUID.
postAcceptAgreement 1 param → 200404409
POST
/agreements/{agreementUuid}/actions/decline
Acquia Declines a Legal Agreement by UUID.
postDeclineAgreement 1 param → 200404409
GET
/agreements/{agreementUuid}/invitees
Acquia Returns a List of Users Invited to Action This Agreement.
getInvitees 1 param → 200404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_agreement (10 properties), Acquia_Cloud_API_Documentation_user-stub-nullable (6 properties), Acquia_Cloud_API_Documentation_user-stub (6 properties), Acquia_Cloud_API_Documentation_invitees (3 properties). Each schema is shown below with its type and property counts.

Acquia_Cloud_API_Documentation_message
object
1 property 1 required
Acquia_Cloud_API_Documentation_user-stub
object
6 properties 6 required
Acquia_Cloud_API_Documentation_error
object
2 properties 2 required
Acquia_Cloud_API_Documentation_user-stub-nullable
object
6 properties 6 required
Acquia_Cloud_API_Documentation_agreements
object
3 properties 3 required
Acquia_Cloud_API_Documentation_links
object
HAL links about the current resource.
1 property 1 required
Acquia_Cloud_API_Documentation_invitees
object
3 properties 3 required
Acquia_Cloud_API_Documentation_agreement
object
10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-agreements-api-openapi.yml Raw ↑

Other APIs Acquia publishes across the network.

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