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
Home
Guides
API Reference
discard
Save Edits
Submit
Suggested Edits
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
Getting Started
Introduction
Authenticating the StackPath API
Creating your first CDN Site
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
Support
Accounts and Users
Accounts
get
Retrieve a StackPath account
Account Policies
get
Get the current policy for the given account
put
Set the current policy for the given account
post
Test permissions for the current user on the given account
Identity Providers
get
Retrieve a StackPath account's links to external identity providers
get
Retrieve an individual StackPath account link to an external identity provider
get
Retrieve a StackPath account's links to external identity providers
get
Retrieve the identity providers available for user authentication
Users
get
Retrieve the users associated with a StackPath account
post
Create a user and attach it to the given account
delete
Unlink a user from its parent account
get
Retrieve a StackPath user account
delete
Delete a user along with its account associations and identities
patch
Update a user's non-essential properties (phone number, etc)
get
Retrieve the StackPath accounts that a user belongs to
post
Change a user's email address
get
Retrieve a user's API credentials
User Applications
post
Create a new authorized application for a user
get
Authorize an existing application for a user
delete
Remove an authorized application from a user
Authentication
post
Generate an OAuth2 access token from API credentials
post
Create new user API credentials
delete
Delete a user's API credential
post
Generate a new API client secret for a user
post
Change a user identity's password
Stacks
Stacks
get
Returns stacks
post
Creates a stack on an account
get
Returns a stack
post
Updates a stack
Stack Policies
get
Get the current policy, if present, for the stack
delete
Delete the current policy for the stack
put
Set the current policy for the stack
post
Test which permissions the current user has on the stack
Sites
Delivery
post
Recheck a certificate's verification details while being issued. This will only work for Stackpath free site certificates.
Metrics
get
Retrieve request metrics for all sites in a stack
Origins
get
Retrieve a stack's site origins
get
Get an origin
patch
Update an origin
get
Retrieve the origins behind a site's scope
post
Connect an origin to a CDN site's scope
Sites
get
Retrieve all sites in a stack
post
Create a site
get
Retrieve an individual site
delete
Delete a site
Site Features
delete
Disable a site's CDN service
post
Enable a site's CDN service
delete
Disable a site's serverless scripting service
post
Enable a site's serverless scripting service
delete
Disable a site's WAF service
post
Enable a site's WAF service
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 the IP addresses used by the StackPath CDN
get
Get the StackPath CDN points of presence
get
Scan a URL from the StackPath edge network and return a performance report
Scan
post
Scan an origin from the CDN
Delivery
get
Get a stack's SSL certificates
post
Add an SSL certificate to a stack
get
Retrieve an individual SSL certificate
delete
Delete an SSL certificate
put
Update an SSL certificate
post
Issue a renewal for an SSL certificate
get
Retrieve the CDN sites associated with an SSL certificate
get
Retrieve a CDN site's SSL certificate manual verification details
get
Retrieve a site's SSL certificates
post
Request an SSL certificate for a CDN site
put
Associate a CDN site with an SSL certificate
put
Update an SSL certificate's hosts
get
Retrieve a CDN site's DNS CNAME targets
Metrics
get
Retrieve request metrics for all CDN sites in a stack
Purge Content
post
Purge cached content for all CDN sites on a stack
get
Retrieve a purge request's status
Configuration
get
Retrieve a CDN site's scopes
post
Create a new CDN site scope
delete
Delete a CDN site scope
get
Retrieve a CDN site's scope configuration
patch
Update a CDN site's scope configuration
get
Retrieve the hostnames configured on a CDN site's scope
post
Add a hostname to a CDN site's scope
delete
Remove a hostname from a CDN site's scope
get
Retrieve the origins behind a CDN site's scope
post
Connect an origin to a CDN site's scope
delete
Disconnect an origin from CDN site's scope
EdgeRules
get
Retrieve all EdgeRules on a CDN site scope
post
Create an EdgeRule on a CDN site scope
get
Retrieve an individual EdgeRule from a CDN site scope
delete
Delete an EdgeRule
get
Retrieve 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 version of a serverless script
Web Application Firewall
Infrastructure
get
Get WHOIS organizations
Delivery
get
Retrieve a stack's associated SSL certificates
post
Create an SSL certificate
get
Retrieve an individual SSL certificate
delete
Delete an SSL certificate
put
Update an SSL certificate
post
Issue a renewal for an SSL certificate
get
Retrieve a WAF site's SSL certificate manual verification details
post
Disable CDN caching on a WAF site
post
Enable CDN caching on a WAF site
get
Retrieve a site's SSL certificates
post
Request an SSL certificate for a WAF site
put
Associate a WAF site with an SSL certificate
get
Retrieve a WAF site's DNS CNAME targets
get
Retrieve a WAF site's Host header value
put
Update a WAF site's Host header value
WAF Features
put
Update an API site's login URLs
put
Update a WAF site's API URLs
get
Retrieve a WAF site's DDOS protection settings
patch
Update a WAF site's DDOS protection settings
delete
Remove a WAF site from monitoring mode
post
Place a WAF site into monitoring mode
put
Update a WAF site's shield POPs
Events
get
Retrieve a WAF site's event statistics
get
Search for a site's WAF events
get
Retrieve an individual WAF event
Policies
get
Retrieve all WAF policy groups
get
Retrieve an individual WAF policy group
post
Disable all policies in a WAF policy group
post
Enable all policies in a WAF policy group
get
Retrieve all policies in a WAF policy group
get
Retrieve an individual WAF policy
post
Disable a WAF policy
post
Enable a WAF policy
Rules
get
Retrieve a site's WAF rules
post
Create a WAF rule
post
Delete multiple WAF rules
get
Retrieve an individual WAF rule
delete
Delete a WAF rule
patch
Update a WAF rule
post
Disable a WAF rule
post
Enable a WAF rule
Traffic
get
Retrieve a report of stack's WAF traffic
DNS
Scanning
get
Scan a domain name for information about its provider
post
Scan a domain name for its resource records
Metrics
get
Retrieve DNS metrics
Zones
get
Retrieve all DNS zones on a stack
post
Create a new DNS zone
get
Retrieve an individual DNS zone
delete
Delete a DNS zone
put
Update a DNS zone
post
Disable a DNS zone
get
Retrieve information about a DNS zone's authoritative nameservers
post
Enable a DNS zone
post
Parse a bind file for its records
post
Publish a zone to StackPath's DNS infrastructure
Resource Records
post
Create or update multiple DNS zone resource records
post
Delete multiple DNS zone resource records
get
Retrieve a DNS zone's resource record
post
Create a new resource record in a DNS zone
get
Retrieve an individual DNS zone resource record
delete
Delete a DNS zone resource record
put
Replace a DNS zone resource record
patch
Update specific fields in a DNS zone resource record
Edge Compute
Workloads
get
Retrieve the locations a workload may be created in
get
Retrieve a stack's workloads
post
Create a new workload
get
Retrieve an individual workload
delete
Delete a workload
patch
Update a workload
Metrics
get
Retrieve usage metrics for all workloads in a stack, a specific workload, or a specific instance in a workload
Instances
get
Retrieve a workload's instances
Instance
get
Get a workload instance
post
Restart an instance
Instance Logs
get
Retrieve a stream of an instance's logs
Edge Compute Networking
Network Policies
get
Get a list of network policies by stack id
post
Create a new network policy
get
Get a network policy
delete
Delete a network policy
put
Update a network policy
SSL
Certificates
get
Get list of certificates on a stack
get
Get a certificate by the certificate id
delete
Delete from the database
patch
Update a certificate. Doing this will create a new CSR and issue a new certificate
get
Get the latest certificate for a given certificate ID
post
Place a renewal request for a certificatea to the ssl provider
post
Revoke the certificate from the ssl provider and delete the database record
Verification
get
Return the text required for http verification of the ssl provider
Monitoring
HTTP Monitoring
get
Get all HTTP monitors
post
Create an HTTP monitor
post
Delete all HTTP monitors
get
Get an HTTP monitor
delete
Delete an HTTP monitor
put
Replace an HTTP monitor
patch
Update an HTTP monitor
get
Get HTTP monitoring errors
get
Get HTTP monitoring locations
get
Get HTTP monitoring metrics
HTTP Monitoring Checks
get
Get all HTTP monitoring checks
post
Create an HTTP monitoring check
post
Delete all HTTP monitoring checks
get
Get an HTTP monitoring check
delete
Delete an HTTP monitoring check
patch
Update an HTTP monitoring check
post
Disable an HTTP monitoring check
post
Enable an HTTP monitoring check
Infrastructure
get
Get monitoring locations
Object Storage
Buckets
get
Retrieve all buckets in the storage provider for a given stack
post
Create a bucket under a stack
get
Retrieve a bucket in the storage provider for a given stack
delete
Delete a given bucket
put
Updates the name of a bucket
Metrics
get
Get all daily utilizations for specific bucket
get
Get all daily utilizations for all buckets on a stack
User Credentials
get
Get credentials for a given user.
post
Generate storage credentials for the given user
delete
Delete provided storage access credentials for the given user
Getting Started
Introduction
Authenticating the StackPath API
Creating your first CDN Site
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