Jump to Content
PowerShell
GuideHelp Doc
PowerShell
Guide
GuideHelp Doc

Get started

  • Overview
  • Authentication
  • Base IDs
  • Version Mapping
  • Error handling and options
  • Support
    • Commands and help
    • Code and tests

API Definitions

  • Function index
    • Copy
      • Endpoint
    • New
      • Category
      • Endpoint
      • Endpoint activation
      • Endpoint deactivation
      • Endpoint from file
      • Endpoint version
      • Endpoint version resource
      • Endpoint version resource operation
      • Endpoint version PII
      • Operations query
    • Get
      • Category
      • Contracts & groups
      • Endpoints
      • Endpoint version
      • Endpoint version cache
      • Endpoint version CORS
      • Endpoint version error responses
      • Endpoint version error response type
      • Endpoint version GraphQL
      • Endpoint version GZIP
      • Endpoint version JWT
      • Endpoint version PII
      • Endpoint version PII params
      • Endpoint version privacy
      • Endpoint version resource
      • Endpoint version resource operation
      • Endpoint version resources & operations
      • Endpoint version routing
      • Endpoint version summary
      • Hostnames
      • Hostnames & groups
      • Operations
      • User entitlements
    • Expand
      • Endpoint details
    • Set
      • Category
      • Endpoint version
      • Endpoint version cache
      • Endpoint version CORS
      • Endpoint version error responses
      • Endpoint version error response type
      • Endpoint version from file
      • Endpoint version GraphQL
      • Endpoint version GZIP
      • Endpoint version JWT
      • Endpoint version PII
      • Endpoint version privacy
      • Endpoint version PII status
      • Endpoint version resource
      • Endpoint version resource operation
      • Endpoint version routing
    • Show/Hide
      • Endpoint (hide)
      • Endpoint version (hide)
      • Endpoint (show)
      • Endpoint version (show)
    • Update
      • Endpoint version PII
    • Remove
      • Category
      • Endpoint
      • Endpoint version
      • Endpoint version PII
      • Endpoint version resource
      • Endpoint version resource operation
    • Test
      • Secure connection
      • Operations

API Key Manager

  • Function index
    • Add
      • Keys to collection
    • New
      • Keys
      • Key collection
      • Throttling counter
    • Export
      • Keys
    • Get
      • Key
      • Key collection
      • Key collection ACL
      • Key collection endpoints
      • Key collection quota
      • Tags
      • Throttling counter
      • Throttling counter endpoints
      • Throttling counter key collections
      • Throttling counter keys
    • Import
      • Keys
    • Set
      • Key
      • Key collection
      • Key collection ACL
      • Key collection quota
      • Throttling counter
    • Move
      • Keys
    • Reset
      • Collection key quota
      • Key quota
    • Restore
      • Keys
    • Revoke
      • Keys
    • Remove
      • Key collection
      • Keys from collection
      • Throttling counter

AppSec

  • Function index
    • Add
      • Policy selected hostnames
      • Configuration selected hostnames
    • New
      • Activations
      • Configuration
      • Configuration version
      • Custom deny action
      • Custom rule
      • Discovered API endpoint
      • Malware policy
      • Match target
      • Policy
      • Rate policy
      • Reputation profile
      • Subscriptions
      • URL protection policy
    • Export
      • Configuration version
    • Get
      • Activation history
      • Activation request status
      • Activation status
      • Available hostnames
      • Configuration
      • Configuration attack payload logging
      • Configuration bypass network lists
      • Configuration evaluation hostnames
      • Configuration evasive path match
      • Configuration version
      • Configuration version notes
      • Configuration HTTP header logs
      • Configuration Pragma settings
      • Configuration request body settings
      • Configuration selected hostnames
      • Contracts & groups
      • Custom deny action
      • Custom rule
      • Custom rule actions
      • Discovered API
      • Discovered API endpoints
      • Failover hostnames
      • Hostname coverage
      • Hostname coverage match targets
      • Hostname overlaps
      • Malware policy
      • Malware policy actions
      • Malware policy content type
      • Match target
      • PII learning
      • Policy
      • Policy adaptive intelligence
      • Policy API request constraints
      • Policy API endpoints
      • Policy attack group action
      • Policy attack group exceptions
      • Policy attack group tuning recommendations
      • Policy attack payload logging
      • Policy bypass network lists
      • Policy evaluation attack group action
      • Policy evaluation attack group exceptions
      • Policy evaluation hostnames
      • Policy evaluation penalty box
      • Policy evaluation rule action
      • Policy evaluation rule exceptions
      • Policy evasive path match
      • Policy IP/Geo Firewall settings
      • Policy HTTP header logs
      • Policy mode
      • Policy penalty box
      • Policy Pragma settings
      • Policy protections
      • Policy request body settings
      • Policy selected hostnames
      • Policy tuning recommendations
      • Prefetch requests
      • Rate policy
      • Rate policy actions
      • Reputation analysis
      • Reputation profile
      • Reputation profile action
      • URL protection policy
      • URL protection policy actions
      • Selectable hostnames
      • SIEM settings
      • SIEM versions
      • Slow POST protection
      • Subscribers
      • WAF rule action
      • WAF rule exceptions
      • WAF rule tuning recommendations
      • WAF rule upgrade details
    • Hide
      • Discovered API
    • Protect
      • Configuration evaluation hostnames
      • Policy evaluation hostnames
    • Rename
      • Configuration
    • Set
      • Configuration attack payload logging
      • Configuration bypass network lists
      • Configuration evaluation hostnames
      • Configuration evasive path match
      • Configuration HTTP header logs
      • Configuration Pragma settings
      • Configuration selected hostnames
      • Configuration request body settings
      • Configuration version notes
      • Custom deny action
      • Custom rule
      • Custom rule action
      • Malware policy
      • Match target
      • Match target order
      • Malware policy action
      • PII learning
      • Policy
      • Policy adaptive intelligence
      • Policy API request constraints
      • Policy attack group action
      • Policy attack group exceptions
      • Policy attack payload logging
      • Policy bypass network lists
      • Policy evaluation attack group action
      • Policy evaluation attack group exceptions
      • Policy evaluation hostnames
      • Policy evaluation mode
      • Policy evaluation penalty box
      • Policy evaluation rule action
      • Policy evaluation rule exceptions
      • Policy evasive path match
      • Policy IP/Geo Firewall settings
      • Policy HTTP header logs
      • Policy mode
      • Policy penalty box
      • Policy Pragma settings
      • Policy protections
      • Policy request body settings
      • Policy selected hostnames
      • Policy tuning recommendations
      • Prefetch requests
      • Rate policy
      • Rate policy actions
      • Reputation analysis
      • Reputation profile
      • Reputation profile action
      • SIEM settings
      • Slow POST protection
      • WAF rule action
      • WAF rule exceptions
      • URL protection policy
      • URL protection policy actions
    • Show
      • Discovered API
    • Update
      • KRS rule set
    • Remove
      • Configuration
      • Configuration version
      • Configuration selected hostnames
      • Custom deny action
      • Custom rule
      • Malware policy
      • Match target
      • Policy
      • Policy selected hostnames
      • Rate policy
      • Reputation profile
      • Subscriptions
      • URL protection policy

China CDN

  • Function index
    • New
      • Property hostname
      • Provision state change
    • Get
      • Deprovision policy
      • Edge hostnames
      • Groups
      • ICP holding entities
      • ICP numbers
      • Property hostname
      • Provision state change
      • Provision states
    • Set
      • Deprovision policy

Certificates

  • Provision certificates
  • Function index
    • Add
      • 3-party certificate
    • New
      • Enrollment
    • Get
      • Certificate history
      • Certificate signing request
      • Change history
      • Change status
      • Change status on staging
      • Deployments
      • Deployment schedule
      • DV history
      • Enrollment
      • Let's Encrypt challenges
      • Post-verification warnings
      • Pre-verification warnings
      • Production deployment
      • Staging deployment
    • Confirm
      • Change
      • Let's Encrypt challenges
      • Post-verification warnings
      • Pre-verification warnings
    • Set
      • Deployment schedule
      • Enrollment
    • Remove
      • Change
      • Enrollment

Client Lists

  • Function index
    • Add
      • List item
    • New
      • Activation
      • Client list
      • Deactivation
    • Get
      • Client list
      • Contracts & groups
      • Activation
      • Activation status
      • List item
      • Snapshot
      • Tags
      • Usage data
    • Set
      • Client list
      • List item
    • Remove
      • Client list
    • Test
      • List items

Cloud Access Manager

  • Manage cloud origin access
  • Function index
    • New
      • Access key
      • Access key version
      • Property lookup
    • Get
      • Access key
      • Access key creation status
      • Access key version
      • Access key version creation status
      • Access key version properties
      • Access key version status
      • Property lookup
    • Remove
      • Access key version

Cloud Wrapper

  • Function index
    • New
      • Configuration
      • Configuration activation
    • Get
      • Auth keys
      • Capacities
      • CDN providers
      • Configuration
      • Locations
      • Origin hostnames
      • Origins
      • Properties
    • Set
      • Configuration
    • Remove
      • Configuration

Cloudlets

  • Set up cloudlet policies
    • Policies
    • Load balancer
    • Origin server
  • Function index
    • Copy
      • Policy
    • New
      • Load balancer
      • Load balancer activation
      • Load balancer version
      • Policy
      • Policy version
      • Policy version activation
      • Policy version deactivation
      • Policy version rule
    • Get
      • Active properties
      • Associated properties
      • Cloudlet
      • Group
      • Load balancer
      • Load balancer activation
      • Load balancer version
      • Policy
      • Policy activation
      • Policy CSV
      • Policy version
      • Policy version rule
      • Schema
    • Set
      • Load balancer
      • Load balancer version
      • Policy
      • Policy version
      • Policy version rule
    • Remove
      • Policy
      • Policy version

Common

  • Function index
    • Clear
      • Akamai data cache
      • Akamai options
    • Get
      • Akamai credentials
      • Akamai options
      • Akamai session
      • Auth grants
      • Netstorage Credentials
    • Invoke
      • Akamai NSAPI request
      • Akamai REST method
      • Akamai request
    • New
      • EdgeGrid auth token
      • Akamai session
      • Akamai options
    • Remove
      • Akamai session
    • Set
      • Akamai data cache
      • Akamai options
      • Akamai session
    • Test
      • OpenAPI
    • Uninstall
      • Uninstall Akamai

Contracts

  • Function index
    • Get
      • Contracts
      • Products per contract
      • Products per reporting group

CP Codes

  • Manage site traffic
  • Function index
    • New
      • Reporting group
    • Get
      • CP code
      • Products
      • Reporting group
      • Watermark limit for CP codes
      • Watermark limit for reporting groups
    • Set
      • CP code
      • Reporting group
    • Remove
      • Reporting group

Datastream

  • Create data streams
  • Data sets
  • Destinations
  • Function index
    • New
      • Activation
      • Data stream
      • Deactivation
    • Get
      • Activation history
      • Data set fields
      • Data stream
      • Groups
      • History
      • Properties
      • Upload metrics
    • Set
      • Data stream
    • Update
      • Data stream
    • Remove
      • Data stream

Edge Diagnostics

  • Function index
    • New
      • Connectivity problems
      • Content problems
      • cURL request
      • Diagnostic link
      • DIG request
      • Error translation
      • ESI debugger
      • GREP request
      • Metadata trace
      • MTR request
      • URL health check
    • Find
      • IP address
    • Get
      • Akamaized URL translation
      • Connectivity problems
      • Content problems
      • Diagnostic data for group
      • Edge server locations
      • Edge server locations for metadata tracing
      • Error statistics
      • Error translation
      • GREP request
      • GTM properties
      • GTM property IPs
      • IPA hostnames
      • Logs
      • Metadata tracer
      • URL health check
    • Test
      • IP verification & location

Edge DNS

  • Function index
    • New
      • Bulk zone create request
      • Bulk zone delete request
      • Change list
      • Record set
      • Zone
    • Compare
      • Zone versions
    • Get
      • Authoritative name servers
      • Bulk zone create results
      • Bulk zone create request status
      • Bulk zone delete request results
      • Bulk zone delete request status
      • Change list
      • Change list diff
      • Change list settings
      • Contract
      • Contracts
      • DNSSEC algorithms
      • DNSSEC status
      • Edge hostnames
      • Groups
      • Master zone file
      • Record set names for change list
      • Record set types
      • Record set types for name and change list
      • Record sets
      • Record sets for change list
      • TSIG key algorithms
      • TSIG keys
      • Users of zone's TSIG key
      • Zone
      • Zone's aliases
      • Zone transfer status
      • Zone version
      • Zone version master file
      • Zone version record set
    • Set
      • Change list settings
      • Master zone file
      • Master zone file upload to change list
      • Record set
      • Record set for change list
      • TSIG key
      • Zone
    • Submit
      • Change list
    • Remove
      • Change list
      • Record set
      • TSIG key
    • Restore
      • Zone version

Edge Hostnames

  • Function index
    • Get
      • Edge hostname
      • Certificate
      • Change request
      • Localization data
      • Products
    • Set
      • Edge hostname
    • Remove
      • Edge hostname

EdgeKV

  • Function index
    • New
      • Access token
      • Item
      • Namespace
    • Get
      • Access token
      • Initialization status
      • Item
      • Namespace
      • Namespace delete
      • Namespace group
      • Permission group
    • Set
      • Default data access policy
      • Namespace
      • Namespace delete
    • Initialize
      • EdgeKV
    • Move
      • Namespace
    • Update
      • Access token
      • Namespace
    • Remove
      • Access token
      • Item
      • Namespace
    • Restore
      • Namespace

EdgeWorkers

  • Function index
    • Copy
      • EdgeWorker
    • New
      • Activation
      • Deactivation
      • EdgeWorker
      • EdgeWorker version
      • Revision activation
      • Secure token
    • Compare
      • Revisions
    • Get
      • Activation
      • Code bundle
      • Contracts
      • Deactivation
      • EdgeWorker
      • EdgeWorker version
      • Limits
      • Permission group
      • Properties
      • Report
      • Resource tiers
      • Revision
      • Revision activation
      • Revision BOM
      • Revision code bundle
    • Set
      • EdgeWorker
      • Revision
    • Undo
      • Activation
    • Remove
      • Activation
      • EdgeWorker
      • EdgeWorker version
    • Test
      • Code bundle

Firewall Rules Notification

  • Function index
    • New
      • Subscriptions
    • Get
      • CIDR blocks
      • Service
      • Subscriptions
    • Set
      • Subscriptions
    • Remove
      • Subscriptions

Global Traffic Management

  • Function index
    • New
      • AS map
      • CIDR map
      • Datacenter
      • Default datacenter
      • Default IP datacenter
      • Domain
      • Geo map
      • Property
      • Resource
    • Get
      • AS map
      • CIDR map
      • Datacenter
      • Datacenter latency
      • Demand
      • Domain
      • Domain history
      • Domain status
      • Geo map
      • IP availability per property
      • Liveness tests per property
      • Liveness test error
      • Load data
      • Load feedback report
      • Property
      • Resource
      • Traffic report per datacenter
      • Traffic report per property
    • Set
      • AS map
      • CIDR map
      • Datacenter
      • Domain
      • Geo map
      • Property
      • Resource
    • Submit
      • Load data
    • Remove
      • AS map
      • CIDR map
      • Datacenter
      • Geo map
      • Property
      • Resource

Identity & Access Management

  • Control access
    • User
    • Admin
  • Function index
    • Block
      • Property users
    • Disable
      • API credential
      • IP allowlist
    • Enable
      • IP allowlist
    • Get
      • Accessible groups
      • Account switch key
      • Admin contact types
      • Admin countries
      • Admin languages
      • Admin password policy
      • Admin products
      • Admin states
      • Admin timeout policy
      • Admin time zones
      • Allowed APIs
      • Allowed CP codes
      • API client
      • API credential
      • Authorized users
      • Blocked properties
      • CIDR block
      • Grantable roles
      • Group
      • IP allowlist status
      • Property
      • Property resources
      • Property users
      • Role
      • User
      • Users affected by moving group
      • User contact types
      • User countries
      • User languages
      • User password policy
      • User products
      • User profile
      • User states
      • User timeout policy
      • User time zones
    • Lock
      • API client
      • User
    • Move
      • Group
      • Property
    • New
      • API client
      • API credential
      • CIDR block
      • Group
      • Role
      • User
    • Remove
      • API client
      • API credential
      • CIDR block
      • Group
      • Role
      • User
    • Reset
      • Multi-factor authentication
      • User password
    • Set
      • API client
      • API credential
      • Blocked properties
      • CIDR block
      • Group
      • Group & role assignments
      • Multi-factor authentication
      • Role
      • User
      • User notifications
      • User password
      • User profile
    • Test
      • CIDR block
    • Unlock
      • API client
      • User

Image & Video Manager

  • Manage policy rules
  • Transform images
  • Function index
    • New
      • Policy
      • Policy set
    • Get
      • Error details
      • Image
      • Log details
      • Policy
      • Policy history
      • Policy set
    • Set
      • Policy
      • Policy set
    • Restore
      • Policy
    • Remove
      • Policy
      • Policy set

Media Services Live

  • Function index
    • New
      • CP code
      • Key
      • Origin
      • Stream
    • Get
      • CDNs
      • Contracts
      • CP codes per origin
      • CP codes per type
      • Origin
      • Publishing locations
      • Stream
      • VOD origins
    • Set
      • Origin
      • Stream
    • Remove
      • Origin
      • Stream

Mutual TLS Edge Truststore

  • Function index
    • Copy
      • CA set version
    • New
      • CA set
      • CA set activation
      • CA set deactivation
      • CA set version
    • Expand
      • CA set details
    • Get
      • CA set
      • CA set activation
      • CA set activities
      • CA set deletion requests
      • CA set version
      • CA set version certificate
    • Set
      • CA set version
    • Remove
      • CA set

Mutual TLS Origin Keystore

  • Function index
    • Complete
      • Client cert version
    • Get
      • CA cert
      • Client cert
      • Client cert version
    • New
      • Client cert
      • Client cert version
    • Remove
      • Client cert version
    • Set
      • Client cert

NetStorage

  • Provision storage
    • Configuration
  • Function index
    • Add
      • FTP key
      • Rsync key
      • SSH key
    • Disable
      • FTP key
      • Rsync key
      • SSH key
      • Upload account
    • Enable
      • FTP key
      • Rsync key
      • SSH key
      • Upload account
    • Get
      • CP code
      • Directory
      • Directory usage
      • Group
      • Purge routine
      • Rule set
      • Snapshot
      • Upload account
      • Zones
    • Measure
      • Object
    • New
      • Auth
      • CP code
      • Directory
      • Group
      • Rule set
      • Snapshot
      • Symlink
      • Upload account
    • Read
      • Directory
      • Object
    • Remove
      • Directory
      • FTP key
      • Object
      • Purge routine
      • Rule set
      • Rsync key
      • Snapshot
      • SSHKey
    • Rename
      • Object
    • Set
      • FTP key
      • Group
      • Object modification time
      • Purge routine
      • Rule set
      • Snapshot
      • Upload account
    • Start
      • Snapshot
    • Update
      • FTP key
    • Write
      • Object

Network Lists

  • Function index
    • Add
      • Element
    • New
      • Activation
      • Network list
      • Subscription
    • Get
      • Activation
      • Activation status
      • Network list
      • Snapshot
    • Set
      • Network list
    • Remove
      • Element
      • Network list
      • Subscription

Property

  • Provision properties
    • Properties
    • Rules
    • Includes
  • Function index
    • Add
      • Bucket hostname
      • Property hostname
      • Property rule
    • New
      • Bulk activation
      • Bulk patch
      • Bulk search
      • Bulk version
      • CP code
      • Edge hostname
      • Include
      • Include activation
      • Include deactivation
      • Include version
      • Property
      • Property activation
      • Property deactivation
      • Property version
    • Compare
      • Bucket hostname
    • Find
      • Property
    • Get
      • Account ID
      • Bucket activation
      • Bucket hostname
      • Bulk activated property
      • Bulk-patched property
      • Bulk search result
      • Bulk-versioned property
      • Child rule snippet
      • Custom behavior
      • Custom override
      • CP code
      • Edge hostname
      • Group
      • Hostname audit history
      • Include
      • Include activation
      • Include behaviors
      • Include criteria
      • Include rules
      • Include rules digest
      • Include version
      • Product
      • Property
      • Property activation
      • Property behaviors
      • Property build
      • Property certificate challenge
      • Property client settings
      • Property contract
      • Property criteria
      • Property hostname
      • Product use cases
      • Property request schema
      • Property rules
      • Property rules digest
      • Property version
      • Property version's includes
      • Rule format
      • Rule format schema
      • Top-level groups
    • Set
      • Client settings
      • Include rules
      • Property hostname
      • Property rules
    • Merge
      • Property rules
    • Undo
      • Bucket activation
      • Include activation
      • Property activation
    • Update
      • Property rule
    • Remove
      • Bucket hostname
      • Include
      • Property
      • Property hostname
      • Property rule
    • Test
      • Include
      • Property rule

Purge

  • Purge cache
  • Function index
    • Clear
      • Akamai cache

Reporting

  • Function index
    • Get
      • Report
      • Report type
      • Report type versions
    • New
      • Report

SIEM

  • Manage security events
  • Function index
    • Get
      • SIEM data
    • Format
      • SIEM event

Site Shield

  • Route traffic
  • Function index
    • Confirm
      • Site shield map
    • Get
      • Site shield map

SLA

  • Set up SLA test configurations
  • Function index
    • New
      • Test configuration
    • Get
      • Availability report
      • Performance report
      • Test agent group
      • Test configuration
      • Test configuration quota
    • Set
      • Test configuration
    • Remove
      • Test configuration

Test Center

  • Function index
    • New
      • Test case
      • Test run
      • Test suite
      • Test variable
    • Get
      • Test case
      • Test catalog template
      • Test condition
      • Test request
      • Test run
      • Test suite
      • Test variable
    • Set
      • Test case
      • Test case order
      • Test suite
      • Test variable
    • Restore
      • Test case
      • Test suite
    • Remove
      • Test case
      • Test suite
      • Test variable

Akamai session

Get-AkamaiSession

Suggest Edits

Synopsis

The Get-AkamaiSession cmdlet gets the current Akamai session information.
Used with Set-AkamaiSession to switch session information.

Syntax

Get-AkamaiSession

Description

Returns an AkamaiSession variable.

Related Links

User Guide: Overview

Updated 22 days ago


  • Table of Contents
    • Synopsis
    • Syntax
    • Description
    • Related Links
Akamai TechDocs
Akamai.com
Linode.com
Contact us
Akamai support Linode support Share feedback
Try Akamai
Log in
Log out
Try Akamai

Akamai.com

Linode.com

Contact us Akamai support Linode support Share feedback

Log in
Log out