> For the complete documentation index, see [llms.txt](https://support.attackforge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.attackforge.com/app/modules/self-service-restful-api.md).

# Self-Service RESTful API

{% hint style="info" %}
See <https://docs.attackforge.com/rest-api/pages/getting-started> for API methods/endpoints.
{% endhint %}

## Accessing the Self-Service RESTFul APIs

You can view which APIs you have access to within the `Integration Docs` section available from the main menu:

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FZbtOheljf4KUF99phPB8%2FScreenshot%202026-10-19%20at%203.58.55%E2%80%AFpm.png?alt=media&amp;token=4b31e965-db5d-458e-af36-9aa5199cb1a0" alt=""><figcaption></figcaption></figure>

Access to every API method/endpoint is *disabled by default for every application user* - even for administrators. If the method shows a `padlock` - that means *you do not have access to that API*.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2F0YjuSVMXOEI4YLbvDn86%2FScreenshot%202026-10-19%20at%203.57.55%E2%80%AFpm.png?alt=media&amp;token=dace0423-a9e1-4cbc-85a5-a23c4d1f6627" alt=""><figcaption></figcaption></figure>

You can be given access to any API in either of the following ways:

1. Administrator grants you direct access to an API method
2. Administrator grants a `Group` access to an API method, and you are a member of that group.

### Granting Individual User Access

1. From the `Users` module, select the user and click on `Access`

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FBFfn4fIxFUs5WGj5degr%2FScreenshot%202026-10-19%20at%204.04.02%E2%80%AFpm.png?alt=media&amp;token=15496db1-8465-40f0-9fe8-59728ef7b0ed" alt=""><figcaption></figcaption></figure>

2. Expand `Self-Service RESTful API`. Click `Add Methods`.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2Fk6aEfiwvSwF72fICQAQs%2FScreenshot%202026-10-19%20at%204.05.11%E2%80%AFpm.png?alt=media&amp;token=a2094144-8054-4c00-b3a0-c6a14e4f8938" alt=""><figcaption></figcaption></figure>

3. Select the required methods. Click `Add`.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2Flna63qMgsTxwA7KF6FnV%2FScreenshot%202026-10-19%20at%204.05.24%E2%80%AFpm.png?alt=media&amp;token=0e6e7640-4d75-40d0-9186-b3ba02612459" alt=""><figcaption></figcaption></figure>

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FG5PiXNIkk2B7pQyPsNoU%2FScreenshot%202026-10-19%20at%204.05.35%E2%80%AFpm.png?alt=media&amp;token=d4601357-1645-401a-ac17-7516205948a0" alt=""><figcaption></figcaption></figure>

### Granting Access to Groups

{% hint style="info" %}
When access to any RESTful API method is granted to a group - every Group Member within the group will receive access to that API method.
{% endhint %}

1. From the `Groups` module, select the group and click on `Other Access`

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FafnSpiMlQt6nKf7tsYKV%2FScreenshot%202026-10-19%20at%204.08.13%E2%80%AFpm.png?alt=media&amp;token=010a4cce-3adb-4f8d-99f9-ec19c4a29e7f" alt=""><figcaption></figcaption></figure>

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2F8NN11dTmd1TqNXShvmol%2FScreenshot%202026-10-19%20at%204.10.18%E2%80%AFpm.png?alt=media&amp;token=d394c731-00cf-4bd3-b2e0-5db9e1eafa2f" alt=""><figcaption></figcaption></figure>

2. Expand `Self-Service RESTful API`. Click `Add Methods`.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2Fk6aEfiwvSwF72fICQAQs%2FScreenshot%202026-10-19%20at%204.05.11%E2%80%AFpm.png?alt=media&amp;token=a2094144-8054-4c00-b3a0-c6a14e4f8938" alt=""><figcaption></figcaption></figure>

3. Select the required methods. Click `Add`.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2Flna63qMgsTxwA7KF6FnV%2FScreenshot%202026-10-19%20at%204.05.24%E2%80%AFpm.png?alt=media&amp;token=0e6e7640-4d75-40d0-9186-b3ba02612459" alt=""><figcaption></figcaption></figure>

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FG5PiXNIkk2B7pQyPsNoU%2FScreenshot%202026-10-19%20at%204.05.35%E2%80%AFpm.png?alt=media&amp;token=d4601357-1645-401a-ac17-7516205948a0" alt=""><figcaption></figcaption></figure>

For more information - see [Getting Started](https://docs.attackforge.com/rest-api/pages/getting-started)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://support.attackforge.com/app/modules/self-service-restful-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
