acapi2 package

Subpackages

Submodules

acapi2.acquia module

Acquia Main Object

class acapi2.acquia.Acquia(api_key=None, api_secret=None, endpoint=None)[source]

Bases: object

agreement(uuid)[source]
Return type

Agreement

agreements()[source]
Return type

AgreementList

property api_endpoint: str
Return type

str

property api_key: str
Return type

str

property api_secret: str
Return type

str

application(uuid)[source]
Return type

Application

applications(filters=None, sort=None, limit=None, offset=None)[source]
Return type

ApplicationList

environment(env_id)[source]
Return type

Environment

get_uri(path)[source]
Return type

str

health()[source]
notification(uuid)[source]
Return type

Notification

permissions()[source]
Return type

PermissionsList

subscription(uuid)[source]
Return type

Subscription

subscriptions(filters=None)[source]
Return type

SubscriptionList

acapi2.exceptions module

Acquia Cloud API Exceptions

exception acapi2.exceptions.AcquiaCloudException[source]

Bases: Exception

Generic Acquia Cloud API Exception.

All acapi2 exceptions should extend this class.

exception acapi2.exceptions.AcquiaCloudNoDataException[source]

Bases: acapi2.exceptions.AcquiaCloudException

No data found exception.

exception acapi2.exceptions.AcquiaCloudNotificationException(message, task)[source]

Bases: acapi2.exceptions.AcquiaCloudException

An Acquia notification exception.

exception acapi2.exceptions.AcquiaCloudNotificationFailedException(message, task)[source]

Bases: acapi2.exceptions.AcquiaCloudNotificationException

An Acquia notification failure exception.

exception acapi2.exceptions.AcquiaCloudTaskFailedException(message, task)[source]

Bases: acapi2.exceptions.AcquiaCloudNotificationException

An Acquia task failure exception.

exception acapi2.exceptions.AcquiaCloudTimeoutError(message, task)[source]

Bases: acapi2.exceptions.AcquiaCloudNotificationException

Timeout exceeded error.

acapi2.http_request module

Module contains http hmac request, supports HTTP persistent connection.

class acapi2.http_request.HttpRequest[source]

Bases: httphmac.request.Request

Class to represent HTTP keep-alive hmac Request.

do()[source]

“Executes the request represented by this object.

The requests library will be used for this purpose. Use requests.Session object for reuse TCP connection. Returns an instance of requests.Response.

acapi2.version module

Module contents

class acapi2.Acquia(api_key=None, api_secret=None, endpoint=None)[source]

Bases: object

agreement(uuid)[source]
Return type

Agreement

agreements()[source]
Return type

AgreementList

property api_endpoint: str
Return type

str

property api_key: str
Return type

str

property api_secret: str
Return type

str

application(uuid)[source]
Return type

Application

applications(filters=None, sort=None, limit=None, offset=None)[source]
Return type

ApplicationList

environment(env_id)[source]
Return type

Environment

get_uri(path)[source]
Return type

str

health()[source]
notification(uuid)[source]
Return type

Notification

permissions()[source]
Return type

PermissionsList

subscription(uuid)[source]
Return type

Subscription

subscriptions(filters=None)[source]
Return type

SubscriptionList