Akamai

Akamai: Prolexic IP Protect Configuration API

Shield your site from DDoS attacks by diverting traffic and scrubbing network packets.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Shield your site from DDoS attacks by diverting traffic and
scrubbing network packets.

Endpoints 9

Mapped IP addresses

  • GETList mapped IP addresses/mips?accountSwitchKey=1-5C0YLB:1-8BYUXReturns IP address ranges for the Akamai Management IP subnets. The Management IPs forward sanitized traffic from an Akamai scrubbing center to your network.

Policy domains

  • GETList policy domains/policy-domains?latest=true&accountSwitchKey=1-5C0YLB:1-8BYUXPolicy domain summary information including domain configurations and subnets.
  • GETGet a policy domain/policy-domains/:pdName?extended=true&accountSwitchKey=1-5C0YLB:1-8BYUXReturns summary information for the specified policy domain. Use the extended parameter to return information about the number of virtual IP addresses…

Virtual IP addresses

  • POSTList virtual IP addresses/policy-domains/vips?accountSwitchKey=1-5C0YLB:1-8BYUXReturns information about the specified virtual IP addresses. Include the IDs of those virtual IP addresses in the vipIds array in the request body.

Health status

  • POSTGet health status/policy-domains/vips/health-stats?accountSwitchKey=1-5C0YLB:1-8BYUXReturns the health status for the specified policy domains in UNIX epoch milliseconds. Akamai retains health statistics for seven days. List domain names in…
  • GETGet health status for a policy domain/policy-domains/:pdName/vips/health-stats?startTime=1614274795000&endTime=1616693995000&accountSwitchKey=1-5C0YLB:1-8BYUXReturns the health status for the specified policy domain. Health status measures the percentage of locations currently available for a back-end IP address.…

Policy configurations

  • GETList policy configurations/policy-domains/:pdName/configs?latest=true&accountSwitchKey=1-5C0YLB:1-8BYUXReturns configuration information for the specified policy domain. By default, this operation returns all the available configuration sets. Use the latest…
  • POSTCreate a new configuration version/policy-domains/:pdName/configs?accountSwitchKey=1-5C0YLB:1-8BYUXAdds new virtual IP addresses (VIPs) and creates or deletes subnets as needed for the specified policy domain. /nThe request body also requires the previously…

Subnets

  • PUTUpdate domain to allocate subnets/policy-domains/:pdName/pd-subnets/allocate?accountSwitchKey=1-5C0YLB:1-8BYUXAdds virtual IP addresses to the specified policy domain. In the request body, use addVips to specify the number of virtual IP addresses you're adding, and…

API details

Base URL
https://{hostname}/ip-protect/v1
Authentication
None declared in the description
Operations
9 operations on 8 pathsGET 5POST 3PUT 1
Main resources
Health status 2Policy configurations 2Policy domains 2Mapped IP addresses 1Subnets 1Virtual IP addresses 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version v1

How to test the Akamai: Prolexic IP Protect Configuration API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Prolexic IP Protect Configuration API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List mapped IP addresses” (GET /mips?accountSwitchKey=1-5C0YLB:1-8BYUX), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: Prolexic IP Protect Configuration API?

Shield your site from DDoS attacks by diverting traffic and scrubbing network packets. It is listed under Developer tools and has 9 endpoints.

Who publishes the Akamai: Prolexic IP Protect Configuration API?

It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Akamai: Prolexic IP Protect Configuration API?

Requests go to https://{hostname}/ip-protect/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Prolexic IP Protect Configuration API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Akamai: Prolexic IP Protect Configuration API have?

9 operations on 8 paths (5 GET, 3 POST, 1 PUT). The largest groups are Health status, Policy configurations, Policy domains, Mapped IP addresses.

Is forking the Akamai: Prolexic IP Protect Configuration API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.