> For the complete documentation index, see [llms.txt](https://docs.silk.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.silk.us/api-reference/getting-started/silk-restful-api.md).

# Silk RESTful API

Manage your Silk environment with web services and integrate it with third-party software.

Silk's RESTful API allows you to manage your environment using web services and enables integration with third-party software. This reference covers the current Silk release.

The API provides a distinct resource URL for each entity collection, and every request and response payload is JSON. Authentication uses HTTP Basic auth over HTTPS.

```
https://{host-address}/api/v2
```

{% hint style="info" %}
All capacity sizes in the RESTful API are in **kilobytes**. Throughput and replication I/O figures are in bytes.
{% endhint %}

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>URL structure and filtering</strong></td><td>Resource URLs, paging, sorting, and filter modifiers.</td><td><a href="/api-reference/using-the-api/url-structure-and-filtering.md">URL structure and filtering</a></td></tr><tr><td><strong>Object manipulation</strong></td><td>Create, get, modify, and delete objects.</td><td><a href="/api-reference/using-the-api/object-manipulation.md">Object manipulation</a></td></tr><tr><td><strong>Authentication and authorization</strong></td><td>Basic auth, HTTPS, and role-based access.</td><td><a href="/api-reference/getting-started/authentication-and-authorization.md">Authentication and authorization</a></td></tr><tr><td><strong>Statistics</strong></td><td>Performance stats, replication stats, and RPO history.</td><td><a href="/api-reference/using-the-api/statistics.md">Statistics</a></td></tr></tbody></table>


---

# 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://docs.silk.us/api-reference/getting-started/silk-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.
