fileUpload

Get all files

Securityapi_key
Request
query Parameters
permanent
boolean
Default: false

This indicates whether the file should be persisted permanently. Note that this should be set to true for files like an OAuth settings file, i.e., files that are not explicitly referenced by a JDBC driver, algorithm or driver support plugin, or connection properties file.

page_number
integer <int64>
Default: 1

The page number for which to get algorithms. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
200

Success

400

Bad request

401

Unauthorized access

get/file-uploads
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Upload file

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API

Securityapi_key
Request
query Parameters
permanent
boolean
Default: false

This indicates whether the file should be persisted permanently. Note that this should be set to true for files like an OAuth settings file, i.e., files that are not explicitly referenced by a JDBC driver, algorithm or driver support plugin, or connection properties file.

Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to be uploaded.

Responses
201

Success

401

Unauthorized access

409

Conflict

post/file-uploads
Response samples
application/json
{
  • "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Delete all files

Securityapi_key
Request
query Parameters
permanent
boolean
Default: false

This indicates whether all of the files that should be deleted are in the permanent upload directory. This defaults to false so all of the files that are deleted are in the temporary upload directory.

Responses
200

Success

400

Bad request

401

Unauthorized access

delete/file-uploads

Get file upload by ID

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API

Securityapi_key
Request
path Parameters
fileUuid
required
string

The unique identifier of the permanently uploaded file to get

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

get/file-uploads/{fileUuid}
Response samples
application/json
{
  • "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Update permanent file upload by ID

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API

Securityapi_key
Request
path Parameters
fileUuid
required
string

The unique identifier of the permanently uploaded file to update

Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to be uploaded.

Responses
201

Success

401

Unauthorized access

409

Conflict

put/file-uploads/{fileUuid}
Response samples
application/json
{
  • "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Delete permanent file upload by ID

Securityapi_key
Request
path Parameters
fileUuid
required
string

The unique identifier of the permanently uploaded file to delete

Responses
200

Success

400

Bad request

401

Unauthorized access

delete/file-uploads/{fileUuid}
➔ Next to inventoryApproval