Files

File actions

List files or download as zip file

get

List or download files from Environment or Enclave

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idanyRequired

The Resource Id

Query parameters

nameanyOptional

Set to provide custom zip file name

Responses

200Success

statusCodeintegerOptionalExample: 500

successbooleanOptionalExample: false

messageanyOptionalExample: List failure

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

get/v1/transfer/resources/{id}

GET /butler/api/v1/transfer/resources/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "500",
  "success": "false",
  "message": "List failure",
  "event": "GET",
  "items": []
}

Copy files

post

Copy files between Environments and Enclaves

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idanyRequired

The Resource Id

Body

actionstring · enumOptional

Type of transfer

Possible values:

sourceIdstringOptional

The source Resource Id

sourceNamestringOptional

The source Resource Id

sourceTypestring · enumOptional

The source Resource Type

Possible values:

targetIdstringOptional

The target Resource Id

targetTypestring · enumOptional

The target Resource Type

Possible values:

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Copy success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

post/v1/transfer/resources/{id}

POST /butler/api/v1/transfer/resources/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "sourceId": "env-e4ba5f67-f2cd-49b9-a507-c315fe1178f0",
  "sourceType": "environment",
  "targetId": "env-9c356734-6ba7-4119-b74b-e863fd2daa93",
  "targetType": "environment",
  "actionType": "copy"
}

{
  "statusCode": "200",
  "success": "true",
  "message": "Copy success",
  "event": "GET",
  "items": []
}

Delete all files

delete

Delete an Environment or Enclave file

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idanyRequired

The Resource Id

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Files delete success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

delete/v1/transfer/resources/{id}

DELETE /butler/api/v1/transfer/resources/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "200",
  "success": "true",
  "message": "Files delete success",
  "event": "GET",
  "items": []
}

Download file

get

Download a file from Environment or Enclave

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idanyRequired

The Resource Id

nameanyRequired

The Resource name

Responses

200

Stream file content. Sets response Content-Disposition to attachment and MIME type from file.

No content

500Error

application/json

get/v1/transfer/resources/{id}/{name}

GET /butler/api/v1/transfer/resources/{id}/{name} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Upload a file

put

Upload a file to an Environment or Enclave

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idanyRequired

The Resource Id

nameanyRequired

The Resource name

Body

filesizestringRequired

File content size

filetypestringRequired

File MIME type

filestorestring · enumOptional

File storage Type

Possible values:

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: File upload success

eventstring · enumOptionalPossible values:

itemsarrayOptional

422Error

application/json

500Error

application/json

put/v1/transfer/resources/{id}/{name}

PUT /butler/api/v1/transfer/resources/{id}/{name} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 54

{
  "filesize": "text",
  "filetype": "text",
  "filestore": "s3"
}

{
  "statusCode": "200",
  "success": "true",
  "message": "File upload success",
  "event": "GET",
  "items": []
}

Delete a file

delete

Delete an Environment or Enclave file

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idanyRequired

The Resource Id

nameanyRequired

The Resource name

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: File delete success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

delete/v1/transfer/resources/{id}/{name}

DELETE /butler/api/v1/transfer/resources/{id}/{name} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "200",
  "success": "true",
  "message": "File delete success",
  "event": "GET",
  "items": []
}