# Authentication

The RocketCAD API relies on API Keys to authenticate requests. API Keys can be created and customized from your [Owner Panel > Integration](https://therocketcad.com/amc) menu.

Your API Keys may carry many permissions, be sure to keep them secure. Do not publicly share your API Key or reveal it in Github, client-side code, etc.

The standard RocketCAD API authentication will appear like the following example:

## Standard RocketCAD API Authentication Example

<mark style="color:green;">`POST`</mark> `https://api.therocketcad.com/api/1.1/wf/ping?api_key=DEVELOPER_TESTING`

In this example, you are only required to supply a valid API Key, such as the example above.

#### Query Parameters

| Name     | Type   | Description                                                                                                                |
| -------- | ------ | -------------------------------------------------------------------------------------------------------------------------- |
| api\_key | string | The API Key query parameter is required for all requests. API Keys can be generated from the Owner Panel > API Access tab. |

#### Request Body

| Name        | Type   | Description                                                          |
| ----------- | ------ | -------------------------------------------------------------------- |
| communityID | string | The communityID body parameter may be required in specific contexts. |
| serverID    | string | The serverID body parameter may be requierd in specific contexts.    |

{% tabs %}
{% tab title="200 " %}

```
{
    "status": "success",
    "response": {
        "success": true,
        "message": "This API Key is valid & associated with an active community."
        "requestID": "OLV213JN6XL1BLS"
    }
}
```

{% endtab %}

{% tab title="400 In the event you fail to provide an API Key as a Query Parameter, you will likely receive a 400: Bad Request error." %}

```
{
    "statusCode": 400,
    "body": {
        "status": "MISSING_DATA",
        "message": "Missing parameter for workflow ping: parameter api_key"
    }
}
```

{% endtab %}

{% tab title="404 While rare, a 404: Not Found error typically indicates there is a temporary API Outage on our end. We encourage you to Contact Support if you encounter this erorr." %}

```
{
    "statusCode": 404,
    "body": {
        "status": "NOT_FOUND",
        "message": "Workflow not found ping"
    }
}
```

{% endtab %}
{% endtabs %}

All API requests must be made over HTTPS. Requests made over HTTP or without authentication as described above will fail.

You may learn more about RocketCAD's User, Community and API Security Practices below.

{% content-ref url="/pages/-MFBy7I0Qy67-NOmPnnS" %}
[Security & Privacy](/about/security-and-privacy.md)
{% endcontent-ref %}

If you're ready to continue, let's learn more about Errors.

{% content-ref url="/pages/-Meufxh\_Xmfe2lt1YG8H" %}
[Errors](/developers/errors.md)
{% endcontent-ref %}


---

# 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.therocketcad.com/developers/authentication.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.
