Akamai

Akamai: Site Shield API

Hide websites and applications from the Internet and restrict clients from accessing the origin.

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

Hide websites and applications from the Internet and restrict
clients from accessing the origin.

Endpoints 3

Maps

  • GETList maps/maps?accountSwitchKey=1-5C0YLB:1-8BYUXReturns a list of all Site Shield maps that belong to your account.
  • GETGet a map/maps/:id?accountSwitchKey=1-5C0YLB:1-8BYUXReturns information about the specified map, such as the map name, firewall addresses, and when the map was last updated.
  • POSTAcknowledge the map/maps/:id/acknowledge?accountSwitchKey=1-5C0YLB:1-8BYUXAcknowledges the proposed firewall update for the specified map. When necessary, the Site Shield Management application issues an update to the IP address…

API details

Base URL
https://{hostname}/siteshield/v1
Authentication
None declared in the description
Operations
3 operations on 3 pathsGET 2POST 1
Main resources
Maps 3
Response formats
application/problem+json application/json
Description format
OpenAPI 3.0.0, API version v1

How to test the Akamai: Site Shield 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: Site Shield 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 maps” (GET /maps?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: Site Shield API?

Hide websites and applications from the Internet and restrict clients from accessing the origin. It is listed under Developer tools and has 3 endpoints.

Who publishes the Akamai: Site Shield 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: Site Shield API?

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

How do I authenticate with the Akamai: Site Shield 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: Site Shield API have?

3 operations on 3 paths (2 GET, 1 POST). The largest groups are Maps.

Is forking the Akamai: Site Shield 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.