API

Secure Internet Access Enterprise Configuration API v3
API summary
OpenAPI schema
Get started
API Concepts
Errors
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 412
- 500

Certificates

Proxy certificates

Policies

Policies
Policy built-in responses
- List built-in responsesget
Policy predefined security categories
- List security category predefined configurationsget

Data Loss Prevention Dictionary

DLP dictionaries
DLP dictionary patterns
DLP regexes

Configurations

Configurations
- List configurationsget
- Onboard a contractpost
Acknowledgments
- Create an acknowledgmentpost
- Get an acknowledgmentget
Custom error pages
- Get a custom error pageget
- Update a custom error pageput
Configuration wizard
- Get the first time wizard stateget
- Update the first time wizardput
Bulk log export
User and group-based policies

Security connectors

Security connectors

Deployments

Deployment configuration
Deployment changes
- List deployment changesget
- List recent changesget

Custom responses

Custom responses

Sites

DNS VIPs
- List DNS VIPsget
Global settings
- Get global settingsget
- Update global settingsput
Sites
Sub-locations
Sublocations

Client Configurations

Client configuration
- Get a client configurationget
- Update a client configurationput
Client versions
Client devices
Client network configurations

Certificates

Proxy certificates

Notifications

Notifications

Lists

Lists
Akamai built-in security lists
- List all Akamai built-in security listsget
DNS cache
- Clear the DNS cachepost

Connection Credentials

VPN credentials
Proxy credentials

Tenant and Delegated Access

Tenants

Change a local security connector password

post https://{hostname}/etp-config/v3/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/change-local-password

Changes the local password for the specified security connector.

Path Params

sinkholeId

integer

required

A unique identifier for the security connector.

configId

integer

required

A unique identifier for the configuration.

Query Params

accountSwitchKey

string

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.

Body Params

newPassword

string

required

length ≥ 1

Plain password meeting the password criteria.

Responses

Headers

object

Location

string

Location URL for the newly created resource.

Response body

object

detail

string

required

length ≥ 1

A human-readable explanation specific to the problem.

errors

array of objects

length ≥ 0

A list of HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.

errors

object

instance

string

required

The URI for this error occurrence.

status

integer

required

≥ 0

The HTTP status code generated by the origin server.

title

string

required

length ≥ 1

A short, human-readable summary of the problem type.

type

string

required

length ≥ 1

A URI reference that identifies the problem type.

Response body

object

code

string

required

length ≥ 1

The problem type.

incidentId

string

required

The unique ID for this incident.

solution

string

required

A short, human-readable problem solution.

title

string

required

length ≥ 1

A short, human-readable summary of the problem type.

Response body

object

detail

string

required

length ≥ 1

A human-readable explanation specific to the problem.

errors

array of objects

length ≥ 0

A list of HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.

errors

object

instance

string

required

The URI for this error occurrence.

status

integer

required

≥ 0

The HTTP status code generated by the origin server.

title

string

required

length ≥ 1

A short, human-readable summary of the problem type.

type

string

required

length ≥ 1

A URI reference that identifies the problem type.

Response body

object

detail

string

required

length ≥ 1

A human-readable explanation specific to the problem.

errors

array of objects

length ≥ 0

A list of HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.

errors

object

instance

string

required

The URI for this error occurrence.

status

integer

required

≥ 0

The HTTP status code generated by the origin server.

title

string

required

length ≥ 1

A short, human-readable summary of the problem type.

type

string

required

length ≥ 1

A URI reference that identifies the problem type.

`x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See Concurrency control for details.

Response body

object

detail

string

required

length ≥ 1

A human-readable explanation specific to the problem.

errors

array of objects

length ≥ 0

A list of HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.

errors

object

instance

string

required

The URI for this error occurrence.

status

integer

required

≥ 0

The HTTP status code generated by the origin server.

type

string

required

length ≥ 1

A URI reference that identifies the problem type.

Updated 2 months ago

Delete a security connector

Generate an activation code for a security connector

Did this page help you?

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/etp-config/v3/configs/configId/akamai-sinkholes/sinkholeId/op/change-local-password \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
 
1
200 OK

Updated 2 months ago

Delete a security connector

Generate an activation code for a security connector

Did this page help you?

200Successful response.

400Validation error.

401Authentication error. See Get started for help setting up your API token.

403Insufficient permissions See Get started for help setting up your API token.

404Configuration not Found.

412Precondition failed. Use the x_etag string returned in the response header as If-Match in write requests to avoid overwriting edits by any other API clients. See Concurrency control for details.

`x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See Concurrency control for details.