Skip to content

README.md

Latest commit

 

History

History
178 lines (114 loc) · 41.4 KB

README.md

File metadata and controls

178 lines (114 loc) · 41.4 KB

Deployments

(deployments)

Overview

Manage your certificate deployments.

Available Operations

put_change_deployment_schedule

Updates the current deployment schedule.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/put-change-deployment-schedule

Example Usage

from aktest_se import Se

s = Se()

res = s.deployments.put_change_deployment_schedule(change_id=10000, enrollment_id=10000, request_body={
    "not_after": None,
    "not_before": "2017-05-19T16:00:00Z",
}, account_switch_key="1-5C0YLB:1-8BYUX")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
change_id int ✔️ The change for this enrollment on which to perform the desired operation. 10000
enrollment_id int ✔️ Enrollment on which to perform the desired operation. 10000
request_body models.PutChangeDeploymentScheduleRequestBody ✔️ N/A
account_switch_key Optional[str] ➖ For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. 1-5C0YLB:1-8BYUX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PutChangeDeploymentScheduleResponseBody

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*

get_deployments

Lists the deployments for an enrollment.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/get-deployments

Example Usage

from aktest_se import Se

s = Se()

res = s.deployments.get_deployments(enrollment_id=10000, account_switch_key="1-5C0YLB:1-8BYUX")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
enrollment_id int ✔️ Enrollment on which to perform the desired operation. 10000
account_switch_key Optional[str] ➖ For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. 1-5C0YLB:1-8BYUX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetDeploymentsResponseBody

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*

get_deployments_production

Gets the enrollments deployed on the production network.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/get-deployments-production

Example Usage

from aktest_se import Se

s = Se()

res = s.deployments.get_deployments_production(enrollment_id=10000, account_switch_key="1-5C0YLB:1-8BYUX")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
enrollment_id int ✔️ Enrollment on which to perform the desired operation. 10000
account_switch_key Optional[str] ➖ For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. 1-5C0YLB:1-8BYUX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetDeploymentsProductionResponseBody

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*

get_deployment_staging

Gets the enrollments deployed on the staging network.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/get-deployment-staging

Example Usage

from aktest_se import Se

s = Se()

res = s.deployments.get_deployment_staging(enrollment_id=10000, account_switch_key="1-5C0YLB:1-8BYUX")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
enrollment_id int ✔️ Enrollment on which to perform the desired operation. 10000
account_switch_key Optional[str] ➖ For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. 1-5C0YLB:1-8BYUX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetDeploymentStagingResponseBody

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*