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

Get the first time wizard state

get https://{hostname}/etp-config/v3/configs/{configId}/firstTimeWizard

Provides the first time wizard status.

Path Params

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.

Headers

If-Match

string

required

Use the x_etag value included in the GET response. See Concurrency control for details.

Responses

Response body

object

playIntroVideo

boolean

required

Marks the introduction video as played.

step

integer

required

≥ 0

Indicates the last step completed in the wizard.

videoLink

string

length ≥ 1

The link to the introduction video.

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.

Updated 8 days ago

Update a custom error page

Update the first time wizard

Did this page help you?

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/etp-config/v3/configs/configId/firstTimeWizard \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "playIntroVideo": false,
3
  "step": 1,
4
  "videoLink": "https://link to video location"
5
}

Updated 8 days ago

Update a custom error page

Update the first time wizard

Did this page help you?

API
Secure Internet Access Enterprise Configuration API v3
API summary
Get started
List types
Certificate status
Deployment status
Timestamp formats
Concurrency control
TLS certificates
Rate Limiting
Get your configuration ID
API Concepts
Errors
500
412
409
406
405
404
403
401
400

Certificates
Proxy certificates
Deactivate a proxy certificatepost
Confirm a proxy certificate's downloadpost
Confirm a proxy certificate's distributionpost
Activate a proxy certificatepost
Modify a proxy certificateput
Get a proxy certificateget
List proxy certificatesget
Create a new proxy certificatepost

Policies
Policies
Get policy metadataget
Remove a policydelete
Update a policyput
Get a policyget
List policiesget
Create a policypost
Policy built-in responses
List built-in responsesget
Policy predefined security categories
List security category predefined configurationsget

Data Loss Prevention Dictionary
DLP dictionaries
Remove a DLP dictionarydelete
Update a DLP dictionaryput
Get a DLP dictionaryget
List DLP dictionariesget
Create a DLP dictionarypost
DLP dictionary patterns
Delete a DLP dictionary patterndelete
Get a DLP dictionary patternget
List DLP dictionary patternsget
Create a DLP patternpost
DLP regexes
Get a DLP regular expressionget
List DLP regular expressionsget
Create DLP regular expressionspost

Configurations
Configurations
Onboard a contractpost
List configurationsget
Acknowledgments
Get an acknowledgmentget
Create an acknowledgmentpost
Custom error pages
Update a custom error pageput
Get a custom error pageget
Configuration wizard
Update the first time wizardput
Get the first time wizard stateget
Bulk log export
Update a bulk log export destination configput
Enable a bulk log export schedulepost
Disable a bulk log export schedulepost
Update a bulk log export scheduleput
List bulk log export schedulesget
Get a bulk log export destination configget
Create a bulk log export destination configpost
User and group-based policies
Delete a group-based policy mappingdelete
Update a group-based policy mappingput
Get a group-based policy mappingget
Delete all group policy mappings for an IDPdelete
List group-based policy mappingsget
Create a group-based policy mappingpost

Security connectors
Security connectors
Update a security connectorput
Upgrade a security connectorpost
Generate an activation code for a security connectorpost
Change a local security connector passwordpost
Delete a security connectordelete
Get a security connectorget
Get the security connector's latest available versionget
List the current security connector versionsget
List security connectorsget
Create a security connectorpost

Deployments
Deployment configuration
Get a configuration deploymentget
List configuration deploymentsget
Create a configuration deploymentpost
Deployment changes
List recent changesget
List deployment changesget

Custom responses
Custom responses
Delete a custom responsedelete
Update a custom responseput
Get a custom responseget
List custom responsesget
Create a custom responsepost

Sites
DNS VIPs
List DNS VIPsget
Global settings
Update global settingsput
Get global settingsget
Sites
Remove a sitedelete
Update a siteput
Get a siteget
Bulk create sitespost
Get site metadataget
List sitesget
Create a sitepost
Sub-locations
Sublocations
Assign a policy to a sitepost
Remove a sublocationdelete
Update a sublocationput
Get a sublocationget
List sublocationsget
Create a sublocationpost

Client Configurations
Client configuration
Update a client configurationput
Get a client configurationget
Client versions
Download a client versionget
Update a client versionput
Rotate the client version entitlement codepost
List client versionsget
Client devices
Get client statusget
Re-activate a client devicepost
Deactivate a client devicepost
List client devicesget
Client network configurations
Update the network configurationput
Get the network configurationget
Create a network configurationpost

Certificates
Proxy certificates
Deactivate a proxy certificatepost
Confirm a proxy certificate's downloadpost
Confirm a proxy certificate's distributionpost
Activate a proxy certificatepost
Modify a proxy certificateput
Get a proxy certificateget
List proxy certificatesget
Create a new proxy certificatepost

Notifications
Notifications
Update the subscribers to notification typeput
Get notification configuration for typeget
Update notification configurationsput
List notification configurationsget
Create notifications configspost

Lists
Lists
Patch a listpatch
Modify list itemsput
Search in a listget
Remove a listdelete
Update a listput
Get details of a listget
List global list quotasget
List all listsget
Create a listpost
Akamai built-in security lists
List all Akamai built-in security listsget
DNS cache
Clear the DNS cachepost

Connection Credentials
VPN credentials
Delete a VPN credentialdelete
Get a VPN credentialget
List VPN credentialsget
Create a VPN credentialpost
Proxy credentials
Remove a proxy credentialdelete
Get a proxy credentialget
List proxy credentialsget
Create a proxy credentialpost

Tenant and Delegated Access
Tenants
List tenant usersget
Remove a tenantdelete
Update a tenantput
Get a tenantget
List all tenantsget
Onboard a tenantpost

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.