# unSkript Documentation

## unSkript Documentation

- [What is unSkript?](https://docs.unskript.com/unskript-documentation/readme.md): Your SRE Co-Pilot: Find, Prioritize and Fix Production Issues
- [Contribute to Open Source](https://docs.unskript.com/unskript-documentation/guides/contribute-to-open-source.md): How to Submit xRunBooks and Actions to Github
- [Getting started](https://docs.unskript.com/unskript-documentation/guides/getting-started.md): Follow the steps on the next few pages, and you'll be up and running in no time!
- [Sign Up/Install](https://docs.unskript.com/unskript-documentation/guides/getting-started/sign-up-install.md): Use our free Cloud sandbox, or install the Open Source Docker Image
- [Authentication](https://docs.unskript.com/unskript-documentation/guides/getting-started/authentication.md): For our Cloud/Free Trial, you must create an account.
- [Okta configuration](https://docs.unskript.com/unskript-documentation/guides/getting-started/authentication/okta-configuration.md): This page describes the steps required to be done inside Okta to enable SSO.
- [Okta Groups Sync](https://docs.unskript.com/unskript-documentation/guides/getting-started/authentication/okta-configuration/okta-groups-sync.md)
- [Create a Proxy](https://docs.unskript.com/unskript-documentation/guides/getting-started/create-a-proxy.md): Proxies are dedicated runtime environments for your unSkript install
- [Add Credentials to Connect your Resources](https://docs.unskript.com/unskript-documentation/guides/getting-started/add-credentials-to-connect-your-resources.md): Connecting to your external tools
- [Key Terms](https://docs.unskript.com/unskript-documentation/guides/getting-started/key-terms.md): Some definitions to help you get started with unSkript xRunBooks
- [Prebuilt xRunBooks](https://docs.unskript.com/unskript-documentation/runbooks/xrunbook_list.md)
- [xRunBooks for CloudOps](https://docs.unskript.com/unskript-documentation/runbooks/xrunbook_list/runbook_cloudops.md)
- [xRunBooks for Cost Optimization](https://docs.unskript.com/unskript-documentation/runbooks/xrunbook_list/runbook_cost_opt.md)
- [xRunBooks for DevOps](https://docs.unskript.com/unskript-documentation/runbooks/xrunbook_list/runbook_devops.md)
- [xRunBooks for IAM](https://docs.unskript.com/unskript-documentation/runbooks/xrunbook_list/runbook_iam.md)
- [xRunBooks for SecOps](https://docs.unskript.com/unskript-documentation/runbooks/xrunbook_list/runbook_secops.md)
- [xRunBooks for SRE](https://docs.unskript.com/unskript-documentation/runbooks/xrunbook_list/runbook_sre.md)
- [xRunBooks for Troubleshooting](https://docs.unskript.com/unskript-documentation/runbooks/xrunbook_list/runbook_troubleshooting.md)
- [Creating RunBooks](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks.md): Build and customize your RunBook.
- [Importing unSkript xRunBooks](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/importing-unskript-xrunbooks.md): Use our pre-configured xRunBooks
- [Create a xRunBook](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/create-a-xrunbook.md)
- [Add an Action](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/add-an-action.md): Expand the functionality of your xRunBook with additional Actions
- [Connecting Actions](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/connecting-actions.md): Connecting Actions to build on one another unleashes the full power of your RunBook
- [Create a RunBook Input Parameter](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/create-a-parameter.md)
- [Create a Credential](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/create-a-credential.md): Connecting your Actions to external services
- [Writing Notes](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/writing-notes.md): Markdown notes make your xRunBooks more readable
- [Running XRunBooks](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/running-xrunbooks.md)
- [Running RunBooks with Approvals](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/running-xrunbooks/running-runbooks-with-approvals.md): Sometimes a RunBook has advanced privileges, and should have a 2nd pari of eyes check each execution.
- [Schedules](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/schedules.md)
- [xRunBook Executions](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/xrunbook-executions.md)
- [Alarms](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/alarms.md): Execute RunBooks based on external events such as Grafana or CloudWatch alarms
- [Create an Alarm Webhook](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/alarms/create-an-alarm-webhook.md): unSkript webhook in order to connect your alerting systems to securely with unSkript.  In this tutorial, we'll walk through the steps to create a webhook.
- [Webhooks for onprem installations](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/alarms/create-an-alarm-webhook/getting-alerts-via-webhook-for-onprem.md)
- [Create a Grafana Alert](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/alarms/create-a-grafana-alert.md): In this document, we'll walk through the steps to create an alert with Grafana.
- [Attaching runbooks to alarms](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/alarms/attaching-runbooks-to-alarms.md): You've created an alert, and connected to an unSkript Webhook. Let's connect it to a RunBook!
- [Folders](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/folders.md)
- [RunBook Outputs](https://docs.unskript.com/unskript-documentation/runbooks/xrunbooks/runbook-outputs.md): If your RunBook is part of a pipeline you'll want the results of the RunBook execution to continue your process
- [What is an Action?](https://docs.unskript.com/unskript-documentation/actions/what-is-an-action.md): Actions are reusable code segments that complete a specific task
- [Create Custom Actions](https://docs.unskript.com/unskript-documentation/actions/create-custom-actions.md)
- [Create Actions with AI](https://docs.unskript.com/unskript-documentation/actions/create-actions-with-ai.md): Use ChatGPT's generative AI to quickly build Actions
- [Actions](https://docs.unskript.com/unskript-documentation/actions/actions.md): Actions are the building blocks for all Runbooks: Use our Open Source collection, or build your own!
- [Action Configuration](https://docs.unskript.com/unskript-documentation/actions/actions/action-configuration.md)
- [Configure Action Inputs](https://docs.unskript.com/unskript-documentation/actions/actions/action-configuration/configure-action-inputs.md): Configure input parameters in your RunBook Actions.
- [Add Action Inputs](https://docs.unskript.com/unskript-documentation/actions/actions/action-configuration/action-inputs.md): The data that your xRunBook supplies to the Action
- [Action Output](https://docs.unskript.com/unskript-documentation/actions/actions/action-configuration/action-output.md)
- [Action Iterator](https://docs.unskript.com/unskript-documentation/actions/actions/action-configuration/action-iterator.md): Run the same action multiple times with different input parameters
- [Using Iterators](https://docs.unskript.com/unskript-documentation/actions/actions/action-configuration/action-iterator/using-iterators.md)
- [Action Poll](https://docs.unskript.com/unskript-documentation/actions/actions/action-configuration/action-poll.md)
- [Action Start Condition](https://docs.unskript.com/unskript-documentation/actions/actions/action-configuration/action-start-condition.md): Skip an Action - or force it to run - based on the xRunBook Status
- [Anatomy of an Action](https://docs.unskript.com/unskript-documentation/actions/actions/anatomy-of-an-action.md)
- [Prebuilt Actions](https://docs.unskript.com/unskript-documentation/actions/action-list.md)
- [What is a HealthCheck?](https://docs.unskript.com/unskript-documentation/healthchecks/what-is-a-healthcheck.md)
- [Create a HealthCheck](https://docs.unskript.com/unskript-documentation/healthchecks/create-a-healthcheck.md): The steps required to create a HealthCheck
- [Create a HealthCheck Folder](https://docs.unskript.com/unskript-documentation/healthchecks/create-a-healthcheck/create-a-healthcheck-folder.md)
- [Adding Checks](https://docs.unskript.com/unskript-documentation/healthchecks/create-a-healthcheck/adding-checks.md): Adding Checks to your HealthCheck
- [HealthCheck Parameters](https://docs.unskript.com/unskript-documentation/healthchecks/healthcheck-parameters.md): Each Healthcheck use parameters.  Most are optional, but can be configured if desired.
- [Running HealthChecks](https://docs.unskript.com/unskript-documentation/healthchecks/running-healthchecks.md): Once you've created the HealthCheck, it is time to run them.
- [HealthCheck Remediation](https://docs.unskript.com/unskript-documentation/healthchecks/healthcheck-remediation.md): One of your HealthChecks has failed. Let's remediate the issue.
- [What is a Workflow?](https://docs.unskript.com/unskript-documentation/workflows/what-is-a-workflow.md): Workflows let you connect RunBooks to create a more dynamic experience
- [Connectors](https://docs.unskript.com/unskript-documentation/connnecting/connectors.md)
- [Airflow](https://docs.unskript.com/unskript-documentation/connnecting/connectors/airflow.md)
- [Airflow Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/airflow/action_airflow.md)
- [AWS](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws.md)
- [AWS Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws.md)
- [AWS Cloudwatch Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_cloudwatch.md)
- [AWS EC2 Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_ec2.md)
- [AWS ECS Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_ecs.md)
- [AWS EKS Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_eks.md)
- [AWS ELB Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_elb.md)
- [AWS IAM Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_iam.md)
- [AWS Postgres Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_postgres.md)
- [AWS RDS Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_rds.md)
- [AWS RedShift Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_redshift.md)
- [AWS S3 Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_s3.md)
- [AWS VPC Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/aws/action_aws/action_aws_vpc.md)
- [Azure](https://docs.unskript.com/unskript-documentation/connnecting/connectors/azure.md)
- [Azure Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/azure/azure-actions.md)
- [ChatGPT](https://docs.unskript.com/unskript-documentation/connnecting/connectors/chatgpt.md)
- [ChatGPT Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/chatgpt/chatgpt-actions.md)
- [Datadog](https://docs.unskript.com/unskript-documentation/connnecting/connectors/datadog.md)
- [Configuring webhook in Datadog](https://docs.unskript.com/unskript-documentation/connnecting/connectors/datadog/configuring-webhook-in-datadog.md)
- [Datadog Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/datadog/action_datadog.md)
- [Datadog Alert Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/datadog/action_datadog/action_datadog_alerts.md)
- [Datadog Metrics Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/datadog/action_datadog/action_datadog_metrics.md)
- [Datadog Monitor Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/datadog/action_datadog/action_datadog_monitor.md)
- [Elasticsearch](https://docs.unskript.com/unskript-documentation/connnecting/connectors/elasticsearch.md)
- [Elasticsearch Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/elasticsearch/elasticsearch-actions.md)
- [GCP](https://docs.unskript.com/unskript-documentation/connnecting/connectors/gcp.md)
- [GCP Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/gcp/action_gcp.md)
- [GCP Bucket Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/gcp/action_gcp/action_gcp_bucket.md)
- [GCP GKE Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/gcp/action_gcp/action_gcp_gke.md)
- [GCP IAM Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/gcp/action_gcp/action_gcp_iam.md)
- [GCP VM Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/gcp/action_gcp/action_gcp_vm.md)
- [Github](https://docs.unskript.com/unskript-documentation/connnecting/connectors/github.md)
- [Github Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/github/action_github.md)
- [Grafana](https://docs.unskript.com/unskript-documentation/connnecting/connectors/grafana.md)
- [Grafana Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/grafana/action_grafana.md)
- [Hadoop](https://docs.unskript.com/unskript-documentation/connnecting/connectors/hadoop.md)
- [Hadoop Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/hadoop/action_hadoop.md)
- [Jenkins](https://docs.unskript.com/unskript-documentation/connnecting/connectors/jenkins.md)
- [Jenkins Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/jenkins/action_jenkins.md)
- [Jira](https://docs.unskript.com/unskript-documentation/connnecting/connectors/jira.md)
- [Jira Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/jira/action_jira.md)
- [Kafka](https://docs.unskript.com/unskript-documentation/connnecting/connectors/apache-kafka.md)
- [Kafka Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/apache-kafka/action_kafka.md)
- [Kubernetes](https://docs.unskript.com/unskript-documentation/connnecting/connectors/kubernetes.md)
- [K8s Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/kubernetes/k8s-actions.md)
- [MongoDB](https://docs.unskript.com/unskript-documentation/connnecting/connectors/mongodb.md)
- [MongoDB Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/mongodb/action_mongodb.md)
- [MS SQL](https://docs.unskript.com/unskript-documentation/connnecting/connectors/ms-sql.md)
- [MSSQL Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/ms-sql/action_mssql.md)
- [MySQL](https://docs.unskript.com/unskript-documentation/connnecting/connectors/mysql.md)
- [MySQL Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/mysql/action_mysql.md)
- [Netbox](https://docs.unskript.com/unskript-documentation/connnecting/connectors/netbox.md)
- [Netbox Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/netbox/action_netbox.md)
- [Nomad](https://docs.unskript.com/unskript-documentation/connnecting/connectors/nomad.md)
- [Nomad Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/nomad/action_nomad.md)
- [OpenSearch](https://docs.unskript.com/unskript-documentation/connnecting/connectors/opensearch.md)
- [opensearch Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/opensearch/action_opensearch.md)
- [Pingdom](https://docs.unskript.com/unskript-documentation/connnecting/connectors/pingdom.md)
- [Pingdom Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/pingdom/action_pingdom.md)
- [Postgres](https://docs.unskript.com/unskript-documentation/connnecting/connectors/postgres.md)
- [Postgres Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/postgres/action_postgresql.md)
- [Prometheus](https://docs.unskript.com/unskript-documentation/connnecting/connectors/prometheus.md)
- [Prometheus Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/prometheus/action_prometheus.md)
- [Redis](https://docs.unskript.com/unskript-documentation/connnecting/connectors/redis.md)
- [Redis Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/redis/action_redis.md)
- [REST](https://docs.unskript.com/unskript-documentation/connnecting/connectors/rest.md)
- [REST Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/rest/action_rest.md)
- [SalesForce](https://docs.unskript.com/unskript-documentation/connnecting/connectors/salesforce.md)
- [SalesForce Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/salesforce/action_salesforce.md)
- [Slack](https://docs.unskript.com/unskript-documentation/connnecting/connectors/slack.md): Connect your xRunBook Actions to Slack. Message your team!
- [Slack Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/slack/action_slack.md)
- [Snowflake](https://docs.unskript.com/unskript-documentation/connnecting/connectors/snowflake.md)
- [Snowflake Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/snowflake/action_snowflake.md)
- [Splunk](https://docs.unskript.com/unskript-documentation/connnecting/connectors/splunk.md)
- [Splunk Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/splunk/action_splunk.md)
- [SSH](https://docs.unskript.com/unskript-documentation/connnecting/connectors/ssh.md)
- [SSH Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/ssh/action_ssh.md)
- [Stripe](https://docs.unskript.com/unskript-documentation/connnecting/connectors/stripe.md)
- [Stripe Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/stripe/action_stripe.md)
- [Terraform](https://docs.unskript.com/unskript-documentation/connnecting/connectors/terraform.md): Run your Terraform Script in an xRunBook
- [Terraform Actions](https://docs.unskript.com/unskript-documentation/connnecting/connectors/terraform/action_terraform.md)
- [Zabbix](https://docs.unskript.com/unskript-documentation/connnecting/connectors/zabbix.md)
- [Proxies](https://docs.unskript.com/unskript-documentation/connnecting/proxies.md)
- [Environment](https://docs.unskript.com/unskript-documentation/connnecting/proxies/connect-your-environment.md): Use the same xRunBook in different settings with environments
- [RunBooks Across Environments: ServiceIDs](https://docs.unskript.com/unskript-documentation/connnecting/proxies/connect-your-environment/runbooks-across-environments-serviceids.md): Run your RunBook across multiple environments
- [unSkript Proxy](https://docs.unskript.com/unskript-documentation/connnecting/proxies/unskript-proxy.md): Set up a unSkript Hosted Proxy
- [AWS Proxy](https://docs.unskript.com/unskript-documentation/connnecting/proxies/aws-proxy.md): Instructions on how to create an unSkript proxy in your AWS Cloud
- [GCP Proxy](https://docs.unskript.com/unskript-documentation/connnecting/proxies/gcp-proxy.md): Create an unSkript Proxy in your Google Cloud
- [Secret store](https://docs.unskript.com/unskript-documentation/connnecting/secret-store.md): Keeping your credentials safe
- [Vault](https://docs.unskript.com/unskript-documentation/connnecting/secret-store/vault.md)
- [Role Based Access Control](https://docs.unskript.com/unskript-documentation/tooling/role-based-access-control.md): Simple access controls give your team access with just the right permission level
- [RBAC Roles](https://docs.unskript.com/unskript-documentation/tooling/role-based-access-control/rbac-roles.md): Access privilege levels in unSkript
- [API reference](https://docs.unskript.com/unskript-documentation/tooling/api-reference.md)
- [Authentication](https://docs.unskript.com/unskript-documentation/tooling/api-reference/authentication.md): Creating and using API tokens
- [Endpoints](https://docs.unskript.com/unskript-documentation/tooling/api-reference/endpoints.md)
- [Executions](https://docs.unskript.com/unskript-documentation/tooling/api-reference/endpoints/executions.md)
- [RunBooks](https://docs.unskript.com/unskript-documentation/tooling/api-reference/endpoints/workflows.md)
- [Schedules](https://docs.unskript.com/unskript-documentation/tooling/api-reference/endpoints/schedules.md): Schedule your xRunBooks via our API
- [Command Line Tool](https://docs.unskript.com/unskript-documentation/tooling/command-line-tool.md): The unSkript Command line tool
- [Notifications](https://docs.unskript.com/unskript-documentation/tooling/notifications.md): Customize your notifications from unSkript
- [Jupyter Notebook 101](https://docs.unskript.com/unskript-documentation/fundamentals/jupyter-notebooks-101.md): An introduction to Jupyter Notebooks
- [DevOps](https://docs.unskript.com/unskript-documentation/use-cases/for-devops.md): Automate away your Toil with RunBooks
- [SRE](https://docs.unskript.com/unskript-documentation/use-cases/for-sre.md): Automate away your Toil with RunBooks
- [AWS Service Quota list](https://docs.unskript.com/unskript-documentation/lists/test.md): Many AWS services have quotas built in, but it can be tricky to discover the Service\_code and quota code.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.unskript.com/unskript-documentation/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
