POST

/api/v1/automation/shares

Create an encrypted share code with expiry and retrieval limit

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/automation/shares" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.

Authentication and permissions#

Authentication: Bearer token

Scopes: runtime:control, secrets:read, rpa:write

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

No path or query parameters declared.

Request body#

Required.

Field	Type	Required
`ids`	`array`	Yes
`name`	`string`	Yes
`expires_in_minutes`	`integer`	Yes
`max_uses`	`integer`	Yes
`include_secrets`	`boolean`	No

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "ids",
          "name",
          "expires_in_minutes",
          "max_uses"
        ],
        "properties": {
          "ids": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "minItems": 1,
            "maxItems": 1000,
            "uniqueItems": true
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "expires_in_minutes": {
            "type": "integer",
            "minimum": 1,
            "maximum": 43200
          },
          "max_uses": {
            "type": "integer",
            "minimum": 1,
            "maximum": 1000
          },
          "include_secrets": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "id",
          "name",
          "expires_at",
          "max_uses",
          "uses",
          "size",
          "sha256",
          "code"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "expires_at": {
            "type": "integer"
          },
          "max_uses": {
            "type": "integer"
          },
          "uses": {
            "type": "integer"
          },
          "size": {
            "type": "integer"
          },
          "sha256": {
            "type": "string"
          },
          "code": {
            "type": "string"
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Verschlüsselten Freigabecode mit Ablauf und Abruflimit erzeugen",
  "tags": [
    "Automation"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "ids",
            "name",
            "expires_in_minutes",
            "max_uses"
          ],
          "properties": {
            "ids": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64
              },
              "minItems": 1,
              "maxItems": 1000,
              "uniqueItems": true
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "expires_in_minutes": {
              "type": "integer",
              "minimum": 1,
              "maximum": 43200
            },
            "max_uses": {
              "type": "integer",
              "minimum": 1,
              "maximum": 1000
            },
            "include_secrets": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "runtime:control",
    "secrets:read",
    "rpa:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id",
              "name",
              "expires_at",
              "max_uses",
              "uses",
              "size",
              "sha256",
              "code"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "expires_at": {
                "type": "integer"
              },
              "max_uses": {
                "type": "integer"
              },
              "uses": {
                "type": "integer"
              },
              "size": {
                "type": "integer"
              },
              "sha256": {
                "type": "string"
              },
              "code": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}