> 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

## Overview

Easily automate workflows using our Self-Service RESTful API. It is perfect for customisations and integrations into your enterprise ecosystem.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FSgid9tAIbTuAbswrC8F5%2FScreenshot%202025-06-24%20at%201.20.09%E2%80%AFpm.png?alt=media&amp;token=66c39b9a-89b7-4ee2-877d-457754639d5e" alt=""><figcaption></figcaption></figure>

You can use the Self-Service RESTful API to:

**Retrieve vulnerabilities for your projects, and export them**\
**into your vulnerability management and/or ticketing systems.**

Import data from external systems and datasources such as CMDB and asset registers;\
vulnerability management tools; and vulnerability template & methodology datasources.

**Create automated workflows for submitting & approving project requests; or**\
**Create automated workflows for new projects and managing project team.**

Retrieve audit logs for the application, or for a user or project.

**Extract analytics such as Top X Most Common Vulnerabilities;**\
**Top X Most Vulnerable Assets; and Top X Most Failed Test Cases.**

Retrieve and update project data such as test cases,\
notes, workspace & executive summary.

**Create assets / scope on a project from a datasource.**

Audit users and create / activate / deactivate users when required.


---

# 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.