> For the complete documentation index, see [llms.txt](https://docs.stepsecurity.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stepsecurity.io/azure-devops/settings/stepsecurity-api.md).

# Stepsecurity API

The StepSecurity API page is an interactive reference for the StepSecurity API endpoints that serve Azure DevOps. Use it to explore available endpoints, read request and response schemas, and try calls against your own organization.

**To reach this page:** open the sidebar and go to Settings > StepSecurity API.

<figure><img src="https://1410514776-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdMU7uDytQwFdSykTeAVU%2Fuploads%2FAJPdaR8mSXzPRVFe1kDu%2Fado-settings-stepsecurity-api.png?alt=media&amp;token=e0965cd7-83e7-42a4-bbd1-821a1c32366d" alt=""><figcaption></figcaption></figure>

Authenticate with your organization API keys. For how to create and rotate those keys, see [StepSecurity API (Org Access)](https://docs.stepsecurity.io/workspace/settings/stepsecurity-api-org-access). For keys that apply across every organization in your tenant, see [StepSecurity API (Tenant Access)](https://docs.stepsecurity.io/administration/admin-console/integrations/stepsecurity-api-tenant-access).

#### The API reference

The reference is rendered from the API's OpenAPI 3.0 specification and shows the current specification version at the top of the page.

| Element                   | What it does                                                                                                 |
| ------------------------- | ------------------------------------------------------------------------------------------------------------ |
| **Download OpenAPI Spec** | Downloads the specification, for generating clients or importing into an API tool                            |
| **Servers**               | Selects the server calls are issued against. The production server is `https://agent.api.stepsecurity.io/v1` |
| **Authorize**             | Supplies your API key to the reference, so you can issue authenticated test calls from the page              |

Endpoints are grouped by function. Select any endpoint to expand it and see its parameters, request body, response schemas, and example values.

#### Making an authenticated call

1. Select the server you want to call under **Servers**.
2. Select **Authorize** and supply your organization API key.
3. Expand the endpoint you want to call.
4. Fill in the path and query parameters. Endpoints scoped to a tenant take a `{customer}` path parameter.
5. Issue the call and review the response.

{% hint style="warning" %}
Calls issued from this page run against the selected server, so a call to the production server acts on real data. Take particular care with `POST`, `PUT`, `PATCH`, and `DELETE` endpoints.
{% endhint %}

#### Endpoint groups

| Group                       | Covers                                                                                             |
| --------------------------- | -------------------------------------------------------------------------------------------------- |
| **Authentication & Access** | Discovering which Azure DevOps organizations your credentials can reach                            |
| **Organization Management** | Listing and creating Azure DevOps organizations for a tenant, and listing the resources under them |
| **Project Management**      | Azure DevOps project operations                                                                    |

The page is generated from the live specification, so the groups and endpoints it shows are always current. Treat the page itself as the source of truth for the exact endpoint list, and download the specification when you need a fixed version to build against.


---

# 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 that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.stepsecurity.io/azure-devops/settings/stepsecurity-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.