The StackPath Developer Portal
Guides
The StackPath Developer Portal
Integrate our platform directly into your products and dynamically protect your edge.
Get Started
API Reference
Home
Guides
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Tutorials
Home
Guides
API Reference
{{search.symbol}}K
discard
Submit
Suggested Edits
The StackPath API
Quick start
Authentication
Error handling
Pagination
Filtering and sorting
Identity and access management
CDN
Static Site With S3
Getting Stack Metrics
Bypass Cache on URL
Serverless Scripting
Introduction
Getting Started
Available APIs
Debugging
CLI Utility
Block Countries
Cookies
Crypto
In-Memory Caching
Modify Headers
Modify Response Body
Request Header Variables
Static Response
Edge Computing
Create a Container Workload
Liveness and Readiness Probes
Using Terraform to Create a Multi-Cloud Load Balancer
Using Cloud-Init with Virtual Machine Workloads
The StackPath API
Quick start
Authentication
Error handling
Pagination
Filtering and sorting
Identity and access management
CDN
Static Site With S3
Getting Stack Metrics
Bypass Cache on URL
Serverless Scripting
Introduction
Getting Started
Available APIs
Debugging
CLI Utility
Block Countries
Cookies
Crypto
In-Memory Caching
Modify Headers
Modify Response Body
Request Header Variables
Static Response
Edge Computing
Create a Container Workload
Liveness and Readiness Probes
Using Terraform to Create a Multi-Cloud Load Balancer
Using Cloud-Init with Virtual Machine Workloads
Accounts and Users
Accounts
get
Get an account
Account Policies
get
Get all account policies
put
Update account policies
post
Test account policies
Users
get
Get all users
post
Create a user
get
Get a user
delete
Delete a user
patch
Update a user
post
Update a user's email address
Authentication
post
Generate a bearer token
get
Get all API credentials
post
Create API credentials
delete
Delete API credentials
post
Create a new API secret
Stacks
Stacks
get
Get all stacks
post
Create a stack
get
Get a stack
patch
Update a stack
Stack Policies
get
Get a stack's IAM policy
delete
Delete a stack's IAM policy
put
Set a stack's IAM policy
post
Test stack policies
Sites
SSL
post
Re-check certificate verification
Metrics
get
Get metrics
Origins
get
Get all origins
get
Get an origin
patch
Update an origin
get
Get a scope's origins
post
Connect an origin to a scope
Sites
get
Get all sites
post
Create a site
get
Get a site
delete
Delete a site
Site Features
delete
Disable CDN
post
Enable CDN
delete
Disable serverless scripting
post
Enable serverless scripting
delete
Disable WAF
post
Enable WAF
Delivery Domains
get
Retrieve the delivery domains configured on a site
post
Add a delivery domain to a site
delete
Remove a delivery domain from a site
Content Delivery Network
Infrastructure
get
Get IP addresses
post
Scan an origin
get
Get points of presence
get
Get POP performance
SSL
get
Get all certificates
post
Add a certificate
get
Get a certificate
delete
Delete a certificate
put
Update a certificate
post
Renew a certificate
get
Get sites associated with a certificate
get
Get verification details
get
Get all site certificates
post
Request a free certificate
put
Get a site's certificate
put
Update SAN hosts
Metrics
get
Get metrics
Purge Content
post
Purge content
get
Get purge status
Configuration
get
Get CNAME targets
get
Get all scopes
post
Create a scope
delete
Delete a scope
get
Get a scope's configuraiton
patch
Update a scope's configuration
get
Get all scope hostnames
post
Add a scope hostname
delete
Delete a scope hostname
get
Get all scope origins
post
Connect an origin to a scope
delete
Delete a scope origin
EdgeRules
get
Get all EdgeRules
post
Create an EdgeRule
get
Get an EdgeRule
delete
Delete an EdgeRule
get
Get an EdgeRule's configuration
patch
Update an EdgeRule's configuration
Serverless Scripting
get
Get all serverless scripts
post
Create a serverless script
get
Get a serverless script
delete
Delete a serverless script
patch
Update a serverless script
get
Get a serverless script version
Web Application Firewall
Infrastructure
get
Get WHOIS organizations
SSL
get
Get all certificates
post
Add a certificate
get
Get a certificate
delete
Delete a certificate
put
Update a certificate
post
Renew a certificate
get
Get sites associated with a certificate
get
Get all site certificates
post
Request a free certificate
put
Update SAN hosts
WAF Features
put
Update API URLs
get
Get DDOS settings
patch
Update DDOS settings
delete
Disable monitoring mode
post
Enable monitoring mode
get
Get all tags
Configuration
get
Get CNAME targets
Events
get
LEGACY: Get event statistics
get
LEGACY: Get all events
get
LEGACY: Get an event
Policies
get
Get all policy groups
patch
Update policy groups
get
Get a policy group
post
Disable all policies in a group
post
Enable all policies in a group
get
Get all policies in a group
get
Get a policy
post
Disable a policy
post
Enable a policy
Requests
get
Get all requests
get
Get a request
get
Get a request's details
Rules
get
Get all rules
post
Create a rule
post
Delete multiple rules
get
Get a rule
delete
Delete a rule
patch
Update a rule
post
Disable a rule
post
Enable a rule
Traffic
get
LEGACY: Get traffic
get
Get traffic
DNS
Scanning
get
Get provider details
post
Get resource records
Metrics
get
Get metrics
Zones
get
Get all zones
post
Create a zone
get
Get a zone
delete
Delete a zone
put
Update a zone
post
Disable a zone
get
Get a zone's nameservers
post
Enable a zone
post
Parse a zone file
post
Publish a zone
Resource Records
post
Create or update multiple records
post
Delete multiple records
get
Get all records
post
Create a record
get
Get a record
delete
Delete a record
put
Update a record
patch
Replace a record
Edge Compute
Infrastructure
get
Get compute locations
Virtual Machine Images
get
Get all images
get
Get a family's images
delete
Delete a family's images
post
Create an image
patch
Update an image
get
Get an image
delete
Delete an image
put
Update deprecation settings
Metrics
get
Get metrics
Workloads
get
Get all workloads
post
Create a workload
get
Get a workload
delete
Delete a workload
patch
Update a workload
Instances
get
Get all workload instances
get
Get a workload instance
post
Restart a workload instance
Instance Logs
get
Get log stream
Edge Compute Networking
Network Policies
post
Create a policy
get
Get all policies
put
Update a policy
get
Get a policy
delete
Delete a policy
SSL
Certificates
get
Get all certificates
get
Get a certificate
delete
Delete a certificate
patch
Update a certificate
get
Get a certificate's latest version
post
Renew a certificate
post
Revoke a certificate
Monitoring
Monitors
post
Disable all monitors
post
Enable all monitors
get
Get all monitors
post
Create a monitor
post
Delete multiple monitors
get
Get a monitor
delete
Delete a monitor
put
Replace a monitor
patch
Update a monitor
get
Get monitoring errors
get
Get a monitor's locations
Infrastructure
get
Get monitoring locations
Alert Conditions
get
Get all alert conditions
post
Create an alert condition
post
Delete multiple alert conditions
get
Get an alert condition
delete
Delete an alert condition
patch
Update an alert condition
post
Disable an alert condition
post
Enable an alert condition
Metrics
get
Get metrics
Monitoring - Legacy
HTTP Monitoring
get
Get all monitors
post
Create a monitor
post
Delete multiple monitors
get
Get a monitor
delete
Delete a monitor
put
Replace a monitor
patch
Update a monitor
get
Get monitoring errors
get
Get a monitor's locations
get
Get metrics
HTTP Monitoring Checks
get
Get all moniotoring checks
post
Create a monitoring check
post
Delete multiple monitoring checks
get
Get a monitoring check
delete
Delete a monitoring check
patch
Update a monitoring check
post
Disable a monitoring check
post
Enable a monitoring check
Infrastructure
get
Get monitoring locations
Object Storage
Buckets
get
Get all buckets
post
Create a bucket
get
Get a bucket
delete
Delete a bucket
put
Update a bucket
Metrics
get
Get bucket metrics
get
Get stack metrics
User Credentials
get
Get credentials
post
Create credentials
delete
Delete credentials
The StackPath API
Quick start
Authentication
Error handling
View All 6
CDN
Static Site With S3
Getting Stack Metrics
Bypass Cache on URL
Serverless Scripting
Introduction
Getting Started
Available APIs
View All 13
Edge Computing
Create a Container Workload
Liveness and Readiness Probes
Using Terraform to Create a Multi-Cloud Load Balancer
View All 4