Akamai

Akamai: Enterprise Application Access API

Manage and control remote access to your applications.

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

Manage and control remote access to your applications.

Endpoints 173

Directory membership

  • GETGet an IDP directory membership/mgmt-pop/idp/:idp_id/directories_membership?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRetrieves associated directory membership of an IDP.

IDP directories

  • GETList IDP directories/mgmt-pop/idpdirectory?contractId=K-0N7RAK7&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists IDP directories.
  • POSTCreate an IDP directory/mgmt-pop/idpdirectory?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new IDP directory.
  • GETGet an IDP directory/mgmt-pop/idpdirectory/:idpdirectory_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets the specified IDP directory.
  • PUTModify an IDP directory/mgmt-pop/idpdirectory/:idpdirectory_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates an existing IDP directory.
  • DELETEDelete an IDP directory/mgmt-pop/idpdirectory/:idpdirectory_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeletes an existing IDP directory.

IDPs

  • GETList IDPs/mgmt-pop/idp?contractId=K-0N7RAK7&expand=true&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists IDPs.
  • POSTCreate an IDP/mgmt-pop/idp?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new IDP.
  • GETGet an IDP/mgmt-pop/idp/:idp_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets a single IDP.
  • PUTModify an IDP/mgmt-pop/idp/:idp_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates an existing IDP.
  • DELETEDelete an IDP/mgmt-pop/idp/:idp_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeletes an existing IDP.
  • POSTDeploy an IDP/mgmt-pop/idp/:idp_id/deploy?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeploys an IDP.

Metadata

  • POSTUpload metadata of an IDP/mgmt-pop/idp/:idp_id/metadata?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUploads metadata to add or update to the IDP.

Status

  • GETGet an IDP status/mgmt-pop/idp/:idp_id/status?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRetrieves the current IDP status.

Directory administration

  • GETList directories/mgmt-pop/directories?contractId=K-0N7RAK7&expand=true&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists directories, with optional filters and pagination.
  • POSTCreate a directory/mgmt-pop/directories?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new directory.
  • POSTSearch a directory/mgmt-pop/directories/search?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXSearches a directory for the specified query string.
  • POSTVerify a directory/mgmt-pop/directories/verify?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXVerifies that directories are reachable by connectors.
  • GETCheck directory verification status/mgmt-pop/directories/verify/:cmd_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXChecks the directory verification status.
  • GETGet a directory/mgmt-pop/directories/:directory_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets a single directory.
  • PUTModify a directory/mgmt-pop/directories/:directory_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates an existing directory.
  • DELETEDelete a directory/mgmt-pop/directories/:directory_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeletes an existing directory.
  • POSTSync a directory/mgmt-pop/directories/:directory_id/sync?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXSynchronizes the external directory with EAA. Directories synchronize automatically every 6 hours.

Directory group membership

  • GETList directory group memberships/mgmt-pop/groupmembership?contractId=K-0N7RAK7&expand=true&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists directory group memberships.
  • POSTCreate a directory group membership/mgmt-pop/groupmembership?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new directory group membership.
  • GETGet a directory group membership/mgmt-pop/groupmembership/:groupmembership_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets a single group membership.
  • DELETEDelete a directory group membership/mgmt-pop/groupmembership/:groupmembership_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeletes an existing group membership.

Directory groups

  • GETList directory groups/mgmt-pop/directories/:directory_id/groups?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists a directory's groups.
  • GETGet a directory group/mgmt-pop/directories/:directory_id/groups/:group_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists the details of a group.
  • GETList directory group users/mgmt-pop/directories/:directory_id/groups/:group_id/users?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists users in a directory group.

User administration

  • GETGet user upload status/mgmt-pop/directories/createusers/status/:cmd_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets a user's upload status.
  • GETVerify user re-invite status/mgmt-pop/directories/reinviteusers/status/:cmd_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets the re-invite status for a user.
  • POSTBulk create users/mgmt-pop/directories/:directory_id/createusers?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates users in bulk for a cloud directory using a CSV.
  • POSTBulk delete user/mgmt-pop/directories/:directory_id/deleteusers?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeletes users in bulk for a cloud directory.
  • POSTRe-invite user to a cloud directory group/mgmt-pop/directories/:directory_id/reinviteusers?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRe-invite users for a cloud directory.
  • GETList directory users/mgmt-pop/directories/:directory_id/users?contractId=K-0N7RAK7&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists users for a directory. Returns a maximum of 1000 users per request. Use the limit and offset parameters to request the next 1000 users.
  • POSTInvite an user to a directory group/mgmt-pop/directories/:directory_id/users?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXInvite an user to a cloud directory.
  • GETList users using autocomplete/mgmt-pop/directories/:directory_id/users/autocomplete?q=abc&contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists user email addresses matching the given string.
  • GETGet a directory user/mgmt-pop/directories/:directory_id/users/byname/:user_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets details of a user.
  • POSTReset MFA user password/mgmt-pop/tenant/mfa/reset?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXResets the one time password (OTP) of a user.

Application IDPs

  • GETList application IDPs/mgmt-pop/appidp?contractId=K-0N7RAK7&expand=true&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists your application IDPs.
  • POSTAssign an IDP to an application/mgmt-pop/appidp?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXAssign an existing IDP to an application. Overwrites any existing IDP assigned to the application.
  • GETGet an application IDP/mgmt-pop/appidp/:appIdpId?contractId=K-0N7RAK7&expand=true&accountSwitchKey=1-5C0YLB:1-8BYUXGet details for a specific application IDP.
  • DELETEDelete an application IDP/mgmt-pop/appidp/:appIdpId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRemoves the IDP assigned to your application.

Application audit logs

  • GETList application audit logs reports/mgmt-pop/application-reports/ops/query?app=example-ssh-1.stage.akamai-access.com,example-tnl-ssh-1.stage.akamai-access.com,ZgcTQNq4SPeHuOpGUakpRA.stage.akamai-access.com,example-ssh2-plog.stage.akamai-access.com,example-tnl1.stage.akamai-access.com&start=1633067800000&end=1633068000000&tz=Asia/Calcutta&limit=30&accountSwitchKey=1-5C0YLB:1-8BYUXLists an audit log report with optional custom filters.

Application bundles

  • GETList application bundles/mgmt-pop/appbundle?expand=true&limit=30&offset=10&contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists your application bundles.
  • POSTCreate an application bundle/mgmt-pop/appbundle?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new application bundle.
  • GETGet an application bundle/mgmt-pop/appbundle/:appBundleId?contractId=K-0N7RAK7&expand=true&accountSwitchKey=1-5C0YLB:1-8BYUXLists details for a specific application bundle by ID.
  • PUTModify an application bundle/mgmt-pop/appbundle/:appBundleId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXModifies an existing application bundle.
  • DELETEDelete an application bundle/mgmt-pop/appbundle/:appBundleId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRemoves an application bundle.
  • POSTDeploy an application bundle/mgmt-pop/appbundle/:appBundleId/deploy?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeploys the specified application bundle.

Application categories

  • GETList application categories/mgmt-pop/appcategories?contractId=K-0N7RAK7&limit=30&expand=true&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists your application categories.
  • POSTCreate an application category/mgmt-pop/appcategories?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreate a new application category.
  • GETGet an application category/mgmt-pop/appcategories/:appCategoryId?contractId=K-0N7RAK7&expand=true&accountSwitchKey=1-5C0YLB:1-8BYUXLists details for a specific application category.
  • PUTModify an application category/mgmt-pop/appcategories/:appCategoryId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXModifies an existing application category.
  • DELETEDelete an application category/mgmt-pop/appcategories/:appCategoryId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRemoves an application category from your Enterprise Application Access product.

Application directories

  • GETList application directories/mgmt-pop/appdirectories?contractId=K-0N7RAK7&expand=true&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists your application directories.
  • POSTCreate or delete application directories/mgmt-pop/appdirectories?contractId=K-0N7RAK7&method=DELETE&accountSwitchKey=1-5C0YLB:1-8BYUXCreates or deletes a set of application and directories.
  • GETGet an application directory/mgmt-pop/appdirectories/:appDirectoryId?contractId=K-0N7RAK7&expand=true&accountSwitchKey=1-5C0YLB:1-8BYUXGet details for a specific application directory.

Application groups

  • POSTAssign directory groups to applications/mgmt-pop/appgroups?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXAssigns one or more directory groups to one or more applications.
  • GETGet an application group/mgmt-pop/appgroups/:appGroupId?contractId=K-0N7RAK7&expand=true&accountSwitchKey=1-5C0YLB:1-8BYUXGet details for an application group.

Application rewrite groups

  • GETList application rewrite groups/mgmt-pop/appgroups?contractId=K-0N7RAK7&expand=true&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists your application groups.
  • GETList the groups assigned to an application/mgmt-pop/apps/:applicationId/groups?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists the groups authorized to access the application.

Applications

  • GETList applications/mgmt-pop/apps?contractId=K-0N7RAK7&expand=true&expand_sdk=true&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists your EAA applications.
  • POSTCreate an application/mgmt-pop/apps?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new application. After successful creation, additional steps are needed to deploy the application, depending on the application type. Refer to…
  • GETGet an application/mgmt-pop/apps/:applicationId?contractId=K-0N7RAK7&expand=true&expand_sdk=true&accountSwitchKey=1-5C0YLB:1-8BYUXLists a specified application.
  • PUTModify an application/mgmt-pop/apps/:applicationId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates the details of an application.
  • DELETEDelete an application/mgmt-pop/apps/:applicationId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRemoves an application.
  • POSTDeploy an application/mgmt-pop/apps/:applicationId/deploy?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeploys an application.
  • GETList directory applications/mgmt-pop/directories/:directory_id/apps?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists applications using the directory.

Block user

  • POSTBlock a user from accessing an IDP/mgmt-pop/idpblockuser/idp/:idp_id/block?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXBlocks a user from accessing an IDP.

Edge keys

  • POSTCreate an edge key/mgmt-pop/apps/:applicationId/edgekey?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGenerates an edge key for an application.

Ghost to Origin

  • POSTCreate a Ghost to Origin key/mgmt-pop/apps/:applicationId/g2o?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXEnables a G2O configuration for an application. Used only if you've enabled Akamai Edge Enforcement.
  • POSTEnable Ghost to Origin (G2O) for an IDP/mgmt-pop/idp/:idp_id/g2o?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXEnable G2O for an IDP.

Services

  • GETList services for an application/mgmt-pop/apps/:applicationId/services?contractId=K-0N7RAK7&expand=true&accountSwitchKey=1-5C0YLB:1-8BYUXLists the services for an application.

URL location rules

  • GETList URL location rules/mgmt-pop/apps/:applicationId/urllocation?contractId=K-0N7RAK7&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists URL location rules for an application.
  • POSTCreate a URL location rule/mgmt-pop/apps/:applicationId/urllocation?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a URL location rule.
  • GETGet a URL location rule/mgmt-pop/apps/:applicationId/urllocation/:locationId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets the URL location rule for an application.
  • PUTModify a URL location rule/mgmt-pop/apps/:applicationId/urllocation/:locationId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXEdits a URL location rule.
  • DELETEDelete a URL location rule/mgmt-pop/apps/:applicationId/urllocation/:locationId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRemoves a URL location rule.

Unblock user

  • POSTUnblock a user from accessing an IDP/mgmt-pop/idpblockuser/idp/:idp_id/unblock?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUnblocks a user from accessing an IDP.

Versions

  • GETList application versions/mgmt-pop/apps/:applicationId/versions?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists application versions.
  • GETGet an application version/mgmt-pop/apps/:applicationId/versions/:versionId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists an application version.
  • PUTCreate a new application version from existing/mgmt-pop/apps/:applicationId/versions/:versionId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCopies the selected application version to a new draft application.

Connectors

  • GETList connectors/mgmt-pop/agents?contractId=K-0N7RAK7&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists connectors.
  • POSTCreate a connector/mgmt-pop/agents?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new connector.
  • GETList application metrics for connector/mgmt-pop/agents/:agentId/app-metrics?app_uuid_url=501E-o63SaWua1GUk7W2ow&start=1633067800000&end=1633068000000&contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists application metrics for the specified connector.
  • GETGet a connector/mgmt-pop/agents/:uuid_url?accountSwitchKey=1-5C0YLB:1-8BYUXRetrieves a single connector by ID.
  • PUTModify a connector/mgmt-pop/agents/:uuid_url?accountSwitchKey=1-5C0YLB:1-8BYUXUpdates an existing connector.
  • DELETEDelete a connector/mgmt-pop/agents/:uuid_url?accountSwitchKey=1-5C0YLB:1-8BYUXDeletes an existing connector.
  • POSTApprove a connector/mgmt-pop/agents/:uuid_url/approve?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXApproves a connector.
  • POSTUpgrade OS packages on a connector/mgmt-pop/agents/:uuid_url/upgrade-os-pkgs?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpgrades an existing connector.
  • GETList connectors for an application/mgmt-pop/apps/:applicationId/agents?contractId=K-0N7RAK7&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists connectors for an application.
  • POSTAssign connectors to an application/mgmt-pop/apps/:applicationId/agents?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXAssign connectors to an application.
  • GETGet a connector for an application/mgmt-pop/apps/:applicationId/agents/:agentId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists connectors for an application.

System metrics

  • GETList connector system metrics/mgmt-pop/agents/:uuid_url/system-metrics?contractId=K-0N7RAK7&period=24h&accountSwitchKey=1-5C0YLB:1-8BYUXLists system metrics for the specified connector.

Certificates

  • GETList certificates/mgmt-pop/certificates?contractId=K-0N7RAK7&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists certificates.
  • POSTCreate a certificate/mgmt-pop/certificates?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new certificate.
  • GETList CA certificate attributes/mgmt-pop/certificates/ca_attributes?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists CA attributes.
  • GETGet a certificate/mgmt-pop/certificates/:certificateId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRetrieves a single certificate by ID.
  • PUTModify a manual certificate/mgmt-pop/certificates/:certificateId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates an existing manual certificate.
  • DELETEDelete a certificate/mgmt-pop/certificates/:certificateId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRemoves an existing certificate.
  • POSTUpload a certificate/mgmt-pop/certificates/:certificateId/upload?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXModifies a certificate.

Rules

  • GETList rules/mgmt-pop/services?contractId=K-0N7RAK7&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists rules.
  • POSTCreate a rule/mgmt-pop/services?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new rule.
  • GETGet a rule/mgmt-pop/services/:id?accountSwitchKey=1-5C0YLB:1-8BYUXGets a single rule by ID.
  • PUTModify a rule/mgmt-pop/services/:id?accountSwitchKey=1-5C0YLB:1-8BYUXUpdates an existing rule.
  • DELETEDelete a rule/mgmt-pop/services/:id?accountSwitchKey=1-5C0YLB:1-8BYUXDeletes an existing rule.
  • PUTModify an access control rule/mgmt-pop/services/:id/rules?accountSwitchKey=1-5C0YLB:1-8BYUXUpdates an existing access control rule.
  • POSTCreate an access control rule/mgmt-pop/services/:id/rules?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new access control rule.

Devices

  • PUTUpdate device status to clear/device-posture/inventory/device/:deviceId/op/clear?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXMarks a device as safe and clear from ETP threats.

Device history

  • GETGet device history/device-posture/inventory/device-history/:deviceId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists device history for a particular device.

Device inventory

  • GETList device inventory/device-posture/inventory/list?deviceId=134&os=mac&browser=chrome&riskRule=12345678&firewall=good&antiMalware=good&clientVersion=0.3.0&mobile=true&screenlock=true&biometric=true&jailbroken=true&diskEncryption=true&etpThreatDetected=true&cbHealthy=true&cbPolicy=default_policy&crowdstrikeHealthy=true&etpClientStatus=not-installed&certProfile=<Cert profile id 1>&antiMalwareProfile=<AM profile id 2>,<AM profile id 3>&search=device_name&sortBy=timestamp&sortOrder=DESC&contractId=K-0N7RAK7&limit=30&offset=10&accountSwitchKey=1-5C0YLB:1-8BYUXLists device inventories.
  • GETList anti-malware status/device-posture/inventory/summary/anti-malware-status?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists anti-malware status signals metrics acquired from device application access. The response groups statuses by value and sums by count.
  • GETList browser activity/device-posture/inventory/summary/browsers?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists installed browser activity metrics for devices connecting to your applications.
  • GETList devices with biometrics/device-posture/inventory/summary/device-biometric?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists activity metrics for biometrics signals acquired from devices accessing your applications. The response groups statuses by value and sums by count.
  • GETList jailbroken devices/device-posture/inventory/summary/device-jailbroken?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists jailbroken device signal metrics acquired from device application access. The response groups statuses by value and sums by count.
  • GETList device activity/device-posture/inventory/summary/device-roll-ups?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists activity metrics of devices connecting to your applications.
  • GETList device screen lock/device-posture/inventory/summary/device-screen-lock?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists device screen lock signal metrics acquired from device application access. The response groups statuses by value and sums by count.
  • GETList firewall status/device-posture/inventory/summary/firewall-status?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists activity metrics for firewall status signals acquired from devices accessing your applications. The response groups statuses by value and sums by count.
  • GETList operating system activity/device-posture/inventory/summary/os?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists activity metrics for installed operating systems of devices connecting to your applications.
  • GETList device risk assessment/device-posture/inventory/summary/risk-assessment?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists activity metrics for risk assessment rules of devices connected to your applications.
  • GETList system disk encryption/device-posture/inventory/summary/system-disk-encryption?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists activity metrics for disk encryption signals acquired from devices accessing your applications. The response groups statuses by value and sums by count.

Risk assessment

  • GETList available browser versions/device-posture/risk-assessment/available-browsers?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists supported browser versions for risk assessment. Unlisted browsers aren't supported for risk assessment.
  • GETList available client versions/device-posture/risk-assessment/available-client-ver?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists supported client versions for risk assessment. Unlisted client versions aren't supported for risk assessment.
  • GETList available operating system versions/device-posture/risk-assessment/available-os-ver?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists supported operating system versions for risk assessment. Unlisted versions aren't supported for risk assessment.
  • GETGet CA and OCSP information/device-posture/risk-assessment/ca-ocsp?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGet CA and OCSP information for use in certificate profiles.
  • GETList certificate profiles/device-posture/risk-assessment/certificate-profiles?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists the existing certificate profiles.
  • POSTCreate certificate profile/device-posture/risk-assessment/certificate-profiles?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new Certificate profile.
  • GETGet certificate profile/device-posture/risk-assessment/certificate-profiles/:certificateProfileId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGet a certificate profile by its id.
  • PUTUpdate certificate profile/device-posture/risk-assessment/certificate-profiles/:certificateProfileId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdate a certificate profile.
  • DELETEDelete certificate profile/device-posture/risk-assessment/certificate-profiles/:certificateProfileId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDelete a certificate profile.
  • GETList anti-malware profiles/device-posture/risk-assessment/certificate-usage/anti-malware-profiles?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists the existing anti-malware profiles.
  • POSTCreate an anti-malware profile/device-posture/risk-assessment/certificate-usage/anti-malware-profiles?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new anti-malware profile.
  • GETGet an anti-malware profile/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/:antiMalwareProfileId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGet an anti-malware profile.
  • PUTUpdate an anti-malware profile/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/:antiMalwareProfileId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdate an Anti-Malware profile.
  • DELETEDelete an anti-malware profile/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/:antiMalwareProfileId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDelete an anti-malware profile.
  • GETGet CA information/device-posture/risk-assessment/certificate-usage/ca?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists CA usage information.
  • GETGet OCSP information/device-posture/risk-assessment/certificate-usage/ocsp?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists OCSP usage information.
  • GETList chosen versions/device-posture/risk-assessment/chosen-versions?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists the chosen versions of different risk assessment dimensions.
  • PUTModify chosen versions/device-posture/risk-assessment/chosen-versions?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates the chosen versions selection of different risk assessment dimensions.
  • POSTTest chosen versions/device-posture/risk-assessment/chosen-versions/test?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXTests the selected versions against the existing risk assessment rules.
  • GETList available operating systems/device-posture/risk-assessment/os-names?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists supported operating systems for risk assessment. Unlisted operating systems aren't supported for risk assessment.
  • GETList Carbon Black integrations/device-posture/risk-assessment/partner/carbon-black?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists the details of existing Carbon Black integration entries.
  • POSTCreate a new Carbon Black integration/device-posture/risk-assessment/partner/carbon-black?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXAdds a new Carbon Black integration.
  • GETGet Carbon Black integration status/device-posture/risk-assessment/partner/carbon-black/status?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGet current status of Carbon Black integration.
  • PUTUpdate Carbon Black integration status/device-posture/risk-assessment/partner/carbon-black/status?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdate current status of Carbon Black integration to either enabled or disabled.
  • POSTCreate a Carbon Black integration/device-posture/risk-assessment/partner/carbon-black/test?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a Carbon Black integration to test against your Device Posture configuration.
  • PUTCreates a Carbon Black integration for testing/device-posture/risk-assessment/partner/carbon-black/test/:integration_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXTests an existing Carbon Black integration against your device posture configuration.
  • GETGet a Carbon Black integration/device-posture/risk-assessment/partner/carbon-black/:integration_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists the details a specific Carbon Black integration.
  • PUTModify a Carbon Black integration/device-posture/risk-assessment/partner/carbon-black/:integration_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates details for a specific Carbon Black integration.
  • DELETEDelete a Carbon Black integration/device-posture/risk-assessment/partner/carbon-black/:integration_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeletes a specific Carbon Black integration.
  • GETList CrowdStrike integrations/device-posture/risk-assessment/partner/crowdstrike?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets existing CrowdStrike integrations.
  • POSTCreate a new CrowdStrike integration/device-posture/risk-assessment/partner/crowdstrike?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXAdds a new CrowdStrike integration entry.
  • GETGet CrowdStrike integration status/device-posture/risk-assessment/partner/crowdstrike/status?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGet current status of CrowdStrike integration.
  • PUTUpdate CrowdStrike integration status/device-posture/risk-assessment/partner/crowdstrike/status?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates current status of CrowdStrike integration to either enabled or disabled.
  • POSTCreate a CrowdStrike integration/device-posture/risk-assessment/partner/crowdstrike/test?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreate a CrowdStrike integration to test against your device posture configuration.
  • PUTCreates a CrowdStrike integration for testing/device-posture/risk-assessment/partner/crowdstrike/test/:integration_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXTest an existing CrowdStrike integration against your device posture configuration.
  • GETGet a CrowdStrike integration/device-posture/risk-assessment/partner/crowdstrike/:integration_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXGets a specific CrowdStrike integration.
  • PUTModify a CrowdStrike integration/device-posture/risk-assessment/partner/crowdstrike/:integration_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates details for a specific integration entry.
  • DELETEDelete a CrowdStrike integration/device-posture/risk-assessment/partner/crowdstrike/:integration_id?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXDeletes a specific CrowdStrike integration.
  • GETList signal names/device-posture/risk-assessment/signal-names?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists supported signal names for risk assessment. Unlisted signals aren't supported for risk assessment.
  • GETList risk tags/device-posture/risk-assessment/tags?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists supported risk tags for risk assessment.
  • POSTCreate risk tag/device-posture/risk-assessment/tags?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXCreates a new risk tag.
  • GETGet a risk tag/device-posture/risk-assessment/tags/:ruleId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists details for a specific risk tag.
  • PUTModify a risk tag/device-posture/risk-assessment/tags/:ruleId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates the details for a specific risk tag.
  • DELETEDelete a tag/device-posture/risk-assessment/tags/:ruleId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXRemoves a risk tag from your device posture configuration.
  • PUTTest risk rule/device-posture/risk-assessment/test/:ruleId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXTests the specified risk rule against existing devices.
  • GETList risk tiers/device-posture/risk-assessment/tiers?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists supported risk tiers for risk assessment.
  • GETGet a risk tier/device-posture/risk-assessment/tiers/:ruleId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists details for a specific risk tier.
  • PUTModify risk tier/device-posture/risk-assessment/tiers/:ruleId?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXUpdates details for a specific risk tier.
  • GETList client versions/device-posture/risk-assessment/versions/client_version?contractId=K-0N7RAK7&accountSwitchKey=1-5C0YLB:1-8BYUXLists supported client versions for risk assessment. Risk assessment doesn't support unlisted client versions.

Admin events reports

  • GETList admin event reports/mgmt-pop/adminevents-reports/ops/reports?contractId=K-0N7RAK7&sts=1563129000000&ets=1563355505606&event_type=login&res_type=user&accountSwitchKey=1-5C0YLB:1-8BYUXLists admin event reports with optional custom filters.

API details

Base URL
https://{hostname}/crux/v1
Authentication
None declared in the description
Operations
173 operations on 114 pathsGET 87POST 44PUT 25DELETE 17
Main resources
Risk assessment 49Connectors 11Device inventory 11User administration 10Directory administration 9Applications 7Certificates 7Rules 7Application bundles 6IDPs 6
Response formats
application/json application/problem+json
Description format
OpenAPI 3.0.0, API version v1

How to test the Akamai: Enterprise Application Access 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: Enterprise Application Access 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 “Get an IDP directory membership” (GET /mgmt-pop/idp/:idp_id/directories_membership?contractId=K-0N7RAK7&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: Enterprise Application Access API?

Manage and control remote access to your applications. It is listed under Developer tools and has 173 endpoints.

Who publishes the Akamai: Enterprise Application Access 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: Enterprise Application Access API?

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

How do I authenticate with the Akamai: Enterprise Application Access 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: Enterprise Application Access API have?

173 operations on 114 paths (87 GET, 44 POST, 25 PUT, 17 DELETE). The largest groups are Risk assessment, Connectors, Device inventory, User administration.

Is forking the Akamai: Enterprise Application Access 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.