Welcome to the New BigPanda API Documentation

Create a Role

US Region

https://api.bigpanda.io

POST

/resources/v2.1/roles

Creates a new role.

System fields

System fields (id, created_by, created_at, and updated_at) will be set automatically. If included in the Create payload, these fields will be discarded.

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token. Your User API Key must be provided in the header, prefixed by the word Bearer.

Example:
Authorization: Bearer [YOUR_USER_API_KEY]

resource_type

For a full list of available resource_types, see the Roles Management documentation.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢201

application/json

201

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.bigpanda.io/resources/v2.1/roles' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "users": [
        "string"
    ],
    "permissions": [
        {
            "resource_type": "analytics",
            "resource_id": null,
            "actions": [
                "full_access"
            ]
        }
    ]
}'

Response Example

{
    "name": "Admin",
    "id": "role-id-123",
    "users": [
        "60c5238222fa63633d935555",
        "5555238222fa63633d93560c"
    ],
    "created_by": "user-id-123",
    "created_at": 1620000000,
    "updated_at": 1620500000,
    "permissions": [
        {
            "resource_type": "environments",
            "resource_id": "624e114fb4d7581100179111",
            "actions": "read"
        }
    ]
}

Modified at 2026-09-04 16:33:43

Roles & Permissions

Retrieve Role by ID

Create a Role

System fields#

Authentication#

resource_type#

Request

Responses

System fields

Authentication

resource_type