Clipboard

Clipboard actions

Get environment clipboard data

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

environmentIdstringRequired

The Environment Id

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Environment {environmentId} clipboard data

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

get/v1/clipboards/{environmentId}

GET /butler/api/v1/clipboards/{environmentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "200",
  "success": "true",
  "message": "Environment {environmentId} clipboard data",
  "event": "GET",
  "items": []
}

Save data to environment clipboard

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

environmentIdstringRequired

The Environment Id

Body

datastringRequiredExample: This text was saved to this Virtual Environment clipboard using the Replica Butler API docs. 🚀

emitbooleanRequiredExample: true

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Environment {environmentId} clipboard data

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

put/v1/clipboards/{environmentId}

PUT /butler/api/v1/clipboards/{environmentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "data": "This text was saved to this Virtual Environment clipboard using the Replica Butler API docs. 🚀",
  "emit": "true"
}

{
  "statusCode": "200",
  "success": "true",
  "message": "Environment {environmentId} clipboard data",
  "event": "GET",
  "items": []
}

Transfer data between environment clipboards

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

environmentIdstringRequired

The source Environment Id

targetIdstringRequired

The target Environment Id

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Environment Clipboard transfer request success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

put/v1/clipboards/{environmentId}/{targetId}

PUT /butler/api/v1/clipboards/{environmentId}/{targetId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "200",
  "success": "true",
  "message": "Environment Clipboard transfer request success",
  "event": "GET",
  "items": []
}