# TCPShield API

The process for integration against the TCPShield API is very easy. We have implemented full functionality and provide full support for our API for users with the pro plan and above.&#x20;

OpenAPI documentation is provided [here](https://swagger.tcpshield.com/). You can also find the repository where this information is hosted [here](https://github.com/TCPShield/api-docs).&#x20;

### API Key&#x20;

Your API key can be grabbed from [your settings page](https://panel.tcpshield.com/pages/profile).&#x20;

![](/files/-MWXYQe3M9Re_GCeLHLp)

Generally speaking, your API key allows the caller to preform any action your normal account can. It goes without saying, but as a reminder, it is extremely important to keep your API key only in trusted hands.&#x20;

### Examples

List all networks:&#x20;

```
curl -H 'X-API-Key: YOUR_API_KEY' https://api.tcpshield.com/networks
```

We will be providing API wrappers in more languages in the future. At this time, if you need support or have questions, the engineers of TCPShield would be happy to assist.&#x20;

### Java API

Our Java API is available at <https://github.com/TCPShield/TCPShield-Java-API-Wrapper>

### Important Information

TCPShield reserves the right to restrict API access for anything we find malicious or overbearing on our systems. We also reserve the right to change the API without warning on the currently published endpoints.&#x20;


---

# Agent Instructions: 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:

```
GET https://docs.tcpshield.com/miscellaneous/tcpshield-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
