Jump to Content
Guides
API Reference
TFC/HCP Migration
Release Notes
YouTube
Log In
Sign Up
Blog
API Reference
Log In
Sign Up
Blog
Guides
API Reference
TFC/HCP Migration
Release Notes
YouTube
Scalr API Documentation
All
Pages
Start typing to search…
JUMP TO
Scalr IACP API
Scalr API Documentation
API Tokens
access-policies
List Access Policies
get
Create an Access Policy
post
Delete Access Policy
del
Get an Access Policy
get
Update an Access Policy
patch
access-tokens
List access tokens
get
Create an Access Token
post
Delete an Access Token
del
Get an Access Token
get
Update an Access Token
patch
List Agent Pool Access Tokens
get
Create an Agent Pool Access Token
post
List access tokens of a service account
get
Create access token for service account
post
access-tokens-public
Exchange OIDC ID token for ephemeral service account access token
post
access-token-usage
Get Access Token Usage
get
accounts-users
List Account to User relationships
get
accounts
List Accounts
get
Get an Account
get
Update Account
patch
Shows Account Metrics
get
Delete SSO bypass users of the account
del
List SSO bypass users of the account
get
Replace SSO bypass users of the account
patch
Add SSO bypass users to the account
post
agent-pools
List Agent Pools
get
Create an Agent Pool
post
Delete an Agent Pool
del
Get an Agent Pool
get
Update an Agent Pool
patch
agents
List Agents
get
Delete an Agent
del
Get an Agent
get
applies
Get an Apply
get
Apply Log
get
auth
Authenticate endpoint for signing in to an existing account.
get
Authenticate endpoint for signing up for a new account.
get
aws-event-bridge-integrations
List AWS EventBridge Integrations
get
Create AWS EventBridge Integration
post
Delete the AWS EventBridge integration
del
Get AWS EventBridge Integration
get
Update AWS EventBridge Integrations
patch
billing-usage
List billing usages.
get
checkov-integrations
List Checkov integrations
get
Create Checkov integration
post
Delete the Checkov integration.
del
Get Checkov integration
get
Update Checkov integration
patch
Resync Checkov external checks.
post
configuration-versions
List Configuration Versions
get
Create a Configuration Version
post
Get a Configuration Version
get
Download Configuration Version
get
cost-estimates
Get a Cost Estimate
get
Cost breakdown JSON output
get
Cost Estimate log
get
datadog-integrations
List Datadog Integrations
get
Create Datadog Integrations
post
Delete the Datadog integration
del
Get Datadog Integration
get
Update Datadog Integrations
patch
drift-detection-schedules
Create Drift Detection Schedule
post
Delete a drift detection schedule
del
Get a drift detection schedule
get
Update a drift detection schedule
patch
environments
List Environments
get
Create an Environment
post
Delete an Environment
del
Get an Environment
get
Update Environment
patch
Delete environment's tags
del
List environment's tags
get
Replace environment's tags
patch
Add tags to the environment
post
event-definitions
List Event Definitions
get
favorite-workspaces
Favorite a workspace
post
Unfavorite a workspace
post
federated-environments
Delete federated environment relationship
del
List environment's federated environments relationship
get
Update federated environments relationships
patch
Create environment's federated environments relationships
post
hook-environment-links
List Hook Environment Links
get
Create Hook Environment Link
post
Delete Hook Environment Link
del
Get Hook Environment Link
get
Update Hook Environment Link
patch
hooks
List Hooks
get
Create Hook
post
Delete Hook
del
Get Hook
get
Update Hook
patch
Resync Hook
post
infracost-integrations
List Infracost integrations
get
Create Infracost integration
post
Delete the Infracost integration.
del
Get Infracost integration
get
Update Infracost integration
patch
logout
Logout the user
get
metrics
Shows Account Metrics in OpenMetrics format
get
module-namespaces
List Module Namespaces
get
Get a Module Namespace
get
Create a Module Namespace
post
Delete a Module Namespace
del
Update a Module Namespace
patch
modules
List Module Versions
get
Get a Module Version
get
Resync a Module Version
post
List Modules
get
Publish a Module
post
Unpublish a Module
del
Get a Module
get
Resync a Module
post
permissions
List Permissions
get
Get a Permission
get
ping
Ping
get
plans
Get a Plan
get
JSON Output
get
Plan Log
get
Sanitized JSON Output
get
policies
Get a Policy
get
policy-checks
Get a Policy Check
get
Override Policy
post
Policy Check Log
get
List Policy Checks
get
policy-group-checks
List Policy Group Check results
get
policy-groups
List Policy Groups
get
Create a Policy Group
post
Delete a Policy Group
del
Get a Policy Group
get
Update a Policy Group
patch
List of policy group check results for pull requests.
get
Resync a Policy Group
post
policy-group-environments
Update policy group environments relationships
patch
Create policy group environments relationships
post
Delete policy group's environment relationship
del
provider-configuration-links
Delete a Provider configuration workspace link
del
Get a Provider configuration link
get
Update a Provider configuration link
patch
List Provider configuration workspace links
get
Attach a Provider configuration to the workspace
post
provider-configuration-params
Delete a Provider configuration parameter
del
Get a Provider configuration parameter
get
Update a Provider configuration parameter
patch
List Provider configuration parameters for specific provider configurations
get
Create a Provider configuration parameter
post
provider-configurations
List Provider configurations
get
Create a Provider configuration
post
Delete a Provider configuration
del
Get a Provider configuration
get
Update a Provider configuration
patch
terraform-module-usage
List terraform module usage namespaces
get
List terraform module sources
get
List terraform module usages
get
Get module usage
get
terraform-module-versions-usage
List terraform module usage
get
List unique terraform module versions
get
terraform-provider-usage
List unique terraform provider sources
get
List terraform provider usages
get
Get provider usage
get
terraform-provider-version-usage
List terraform provider version usages
get
List unique terraform provider versions
get
terraform-resource-usage
List unique terraform resource provider types
get
List terraform resource usages
get
Get resource usage
get
terraform-resource-instances-usage
List terraform resource instances usage
get
terraform-version-usage
List terraform versions usage
get
List unique terraform versions in use
get
remote-state-consumers
Delete remote state consumers
del
List remote state consumers
get
Replace remote state consumers
patch
Add remote state consumers
post
roles
List Roles
get
Create a Role
post
Delete a Role
del
Get a Role
get
Update a Role
patch
run-schedule-rules
List all run schedule rules.
get
Create a Run schedule rule.
post
Delete a Schedule Rule.
del
Get a Run schedule rule.
get
Update a Run schedule rule.
patch
run-triggers
Create a Run Trigger.
post
Delete a Run Trigger
del
Get a Run Trigger
get
runs
List Runs
get
Create a Run
post
List Runs Queue
get
Get a Run
get
Apply a Run
post
Cancel a Run
post
Discard a Run
post
Force Run
post
Download a Policy Input
get
saml-integrations
List SAML Integrations
get
Create SAML Integration
post
Delete SAML Integration
del
Get SAML Integration
get
Update SAML Integration
patch
security_rules
Get Security Rules
get
Update Security Rules
patch
service-accounts
List service account assume policies
get
List Service Accounts
get
Create a Service Account
post
Delete a Service Account
del
Get a Service Account
get
Update a Service Account
patch
Create an assume service account policy
post
Delete an assume service account policy
del
Get an assume service account policy
get
Update an assume service account policy
patch
slack-connections
Delete Slack connection
del
Get Slack connection
get
List Slack channels
get
Get Slack channel
get
slack-integrations
List Slack Integrations
get
Create Slack Integration
post
Delete the Slack integration
del
Get Slack Integration
get
Update Slack Integration
patch
storage_profile
List Storage Profiles
get
Create Storage Profile
post
Delete Storage Profile
del
Get Storage Profile
get
Update Storage Profile
patch
software-versions
List software versions
get
Get a Software Version
get
ssh-key-links
Delete a link between a workspace and an SSH key
del
Create a link between a workspace and an SSH key
post
ssh_keys
List SSH keys
get
Create a SSH Key
post
Delete an SSH Key
del
Get a SSH Key
get
Update an SSH Key
patch
state-versions
List Workspace's State Versions
get
Create a State Version
post
Get a State Version
get
Download State Version
get
Get Workspace's Current State Version
get
tags
List Tags
get
Create a Tag
post
Delete a Tag
del
Get a Tag
get
Update a Tag
patch
teams
List Teams
get
Create a Team
post
Delete a Team
del
Get a Team
get
Update a Team
patch
usage-statistics
List Scalr Usage Statistics
get
users
Invite a User to the Account
post
Remove a User from the Account
del
List Users
get
Create a User
post
Delete a User
del
Get a User
get
Update a User
patch
variables
List Variables
get
Create a Variable
post
Delete a Variable
del
Get a Variable
get
Update a Variable
patch
vcs-providers
List VCS Providers
get
Create a VCS Provider
post
Delete a VCS Provider
del
Get a VCS Provider
get
Update a VCS Provider
patch
vcs-tasks
Create a task to queue runs from the commit for VCS-driven workspaces.
post
webhook_integration_deliveries
List Webhook Integration Deliveries
get
Get Webhook Integration Delivery
get
webhook-integrations
List Webhooks
get
Create Webhook integration
post
Delete a Webhook integration
del
Get a Webhook
get
Update Webhook integration
patch
workload-identity-providers
List Workload Identity Providers
get
Create a Workload Identity Provider
post
Delete a Workload identity provider
del
Get Workload Identity Provider
get
Update a Workload Identity Provider
patch
workspaces
List Workspaces
get
Create a Workspace
post
Delete a Workspace
del
Get a Workspace
get
Update a Workspace
patch
Lock a Workspace
post
Resync a Workspace
post
Set scheduled runs for the workspace
post
Unlock a Workspace
post
List workspace's outputs.
get
Delete workspace's tags
del
List workspace's tags
get
Replace workspace's tags
patch
Add tags to the workspace
post
Powered by
Scalr API Documentation
Ask AI
