Jump to Content
Guides
API Reference
TFC/HCP Migration
Release Notes
YouTube
Log In
Sign Up
Blog
API Reference
Log In
Sign Up
Blog
Moon (Dark Mode)
Sun (Light Mode)
Guides
API Reference
TFC/HCP Migration
Release Notes
YouTube
vcs-providers
Search
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
delete
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
delete
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
accounts-users
List Account to User relationships
get
accounts
List Accounts
get
Get an Account
get
Update Account
patch
Shows Account Metrics
get
users
Invite a User to the Account
post
Remove a User from the Account
delete
List Users
get
Create a User
post
Delete a User
delete
Get a User
get
Update a User
patch
agent-pools
List Agent Pools
get
Create an Agent Pool
post
Delete an Agent Pool
delete
Get an Agent Pool
get
Update an Agent Pool
patch
agents
List Agents
get
Delete an Agent
delete
Get an Agent
get
applies
Get an Apply
get
Apply Log
get
service-accounts
List service account assume policies
get
List Service Accounts
get
Create a Service Account
post
Delete a Service Account
delete
Get a Service Account
get
Update a Service Account
patch
Create an assume service account policy
post
Delete an assume service account policy
delete
Get an assume service account policy
get
Update an assume service account policy
patch
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
environments
List Environments
get
Create an Environment
post
Delete an Environment
delete
Get an Environment
get
Update Environment
patch
Delete environment's tags
delete
List environment's tags
get
Replace environment's tags
patch
Add tags to the environment
post
federated-environments
Delete federated environment relationship
delete
List environment's federated environments relationship
get
Update federated environments relationships
patch
Create environment's federated environments relationships
post
event-definitions
List Event Definitions
get
hook-environment-links
List Hook Environment Links
get
Create Hook Environment Link
post
Delete Hook Environment Link
delete
Get Hook Environment Link
get
Update Hook Environment Link
patch
hooks
List Hooks
get
Create Hook
post
Delete Hook
delete
Get Hook
get
Update Hook
patch
Resync Hook
post
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
delete
Get AWS EventBridge Integration
get
Update AWS EventBridge Integrations
patch
datadog-integrations
List Datadog Integrations
get
Create Datadog Integrations
post
Delete the Datadog integration
delete
Get Datadog Integration
get
Update Datadog Integrations
patch
infracost-integrations
List Infracost integrations
get
Create Infracost integration
post
Delete the Infracost integration.
delete
Get Infracost integration
get
Update Infracost integration
patch
saml-integrations
List SAML Integrations
get
Create SAML Integration
post
Delete SAML Integration
delete
Get SAML Integration
get
Update SAML Integration
patch
slack-integrations
List Slack Integrations
get
Create Slack Integration
post
Delete the Slack integration
delete
Get Slack Integration
get
Update Slack Integration
patch
slack-connections
Delete Slack connection
delete
Get Slack connection
get
List Slack channels
get
Get Slack channel
get
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
delete
Get a Webhook
get
Update Webhook 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
delete
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
delete
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
delete
Get a Policy Group
get
Update a Policy Group
patch
List of policy group check results for pull requests.
get
policy-group-environments
Update policy group environments relationships
patch
Create policy group environments relationships
post
Delete policy group's environment relationship
delete
provider-configuration-links
Delete a Provider configuration workspace link
delete
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
delete
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
delete
Get a Provider configuration
get
Update a Provider configuration
patch
access-token-usage
Get Access Token Usage
get
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
roles
List Roles
get
Create a Role
post
Delete a Role
delete
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.
delete
Get a Run schedule rule.
get
Update a Run schedule rule.
patch
run-triggers
Create a Run Trigger.
post
Delete a Run Trigger
delete
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
access-tokens-public
Exchange OIDC ID token for ephemeral service account access token
post
software-versions
List software versions
get
Get a Software Version
get
ssh_keys
List SSH keys
get
Create a SSH Key
post
Delete an SSH Key
delete
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
storage_profile
Get Storage Profile
get
Create Storage Profile
post
Delete Storage Profile
delete
List Storage Profiles
get
Update Storage Profile
patch
tags
List Tags
get
Create a Tag
post
Delete a Tag
delete
Get a Tag
get
Update a Tag
patch
teams
List Teams
get
Create a Team
post
Delete a Team
delete
Get a Team
get
Update a Team
patch
usage-statistics
List Scalr Usage Statistics
get
variables
List Variables
get
Create a Variable
post
Delete a Variable
delete
Get a Variable
get
Update a Variable
patch
vcs-providers
List VCS Providers
get
Create a VCS Provider
post
Delete a VCS Provider
delete
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
workload-identity-providers
List Workload Identity Providers
get
Create a Workload Identity Provider
post
Delete a Workload identity provider
delete
Get Workload Identity Provider
get
Update a Workload Identity Provider
patch
workspaces
List Workspaces
get
Create a Workspace
post
Delete a Workspace
delete
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
delete
List workspace's tags
get
Replace workspace's tags
patch
Add tags to the workspace
post
remote-state-consumers
Delete remote state consumers
delete
List remote state consumers
get
Replace remote state consumers
patch
Add remote state consumers
post
ssh-key-links
Delete a link between a workspace and an SSH key
delete
Create a link between a workspace and an SSH key
post
hooks
provider-configurations
security_rules
variables
vcs-providers
workspaces
vcs-providers
