> For the complete documentation index, see [llms.txt](https://guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/settings-apis-1.md).

# Settings APIs

Endpoints for retrieving and updating Guardian system settings, such as Hedera operator credentials and IPFS configuration.

**Authentication:** Bearer token required (`Authorization: Bearer <token>`)

**Permission:** Standard Registry role required.

***

| Method | Endpoint           | Description                                  | Auth Required |
| ------ | ------------------ | -------------------------------------------- | ------------- |
| `GET`  | `/api/v1/settings` | Returns the current Guardian system settings | Yes           |
| `POST` | `/api/v1/settings` | Updates the Guardian system settings         | Yes           |

## Endpoints

* [Displaying Current Settings](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/settings-apis-1/displaying-current-settings.md)
* [Adding Settings](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/settings-apis-1/adding-settings.md)

***

## Branding

Endpoints for updating and retrieving the platform branding configuration.

| Method | Endpoint           | Description                                         | Auth Required |
| ------ | ------------------ | --------------------------------------------------- | ------------- |
| `POST` | `/api/v1/branding` | Updates the platform branding configuration         | Yes           |
| `GET`  | `/api/v1/branding` | Returns the current platform branding configuration | No            |

***

## IPFS File Operations

Endpoints for uploading, retrieving, and deleting files on IPFS.

| Method   | Endpoint                               | Description                                | Auth Required |
| -------- | -------------------------------------- | ------------------------------------------ | ------------- |
| `POST`   | `/api/v1/ipfs/file`                    | Uploads a file to IPFS                     | Yes           |
| `POST`   | `/api/v1/ipfs/file/direct`             | Uploads raw JSON data directly to IPFS     | Yes           |
| `POST`   | `/api/v1/ipfs/file/dry-run/{policyId}` | Uploads a file to IPFS in dry-run mode     | Yes           |
| `GET`    | `/api/v1/ipfs/file/{cid}`              | Retrieves a file from IPFS by its CID      | Yes           |
| `GET`    | `/api/v1/ipfs/file/{cid}/dry-run`      | Retrieves a file from IPFS in dry-run mode | Yes           |
| `DELETE` | `/api/v1/ipfs/file/{cid}`              | Removes (unpins) a file from IPFS          | Yes           |


---

# 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://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/settings-apis-1.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.
