xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs' \ --header 'Authorization: Bearer {token}' \ --data page_size=25 \ --data page_num=0
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Create Job

Creates a new job.

Auth

Request Body

object object

POST /vault_rest/jobs

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/jobs' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

201

Created

object object

Response

xxxxxxxxxx
 
{}
Copy

Read Job Statuses

Retrieves a paginated list of job statuses for the current user.

Auth

Query String

page_size	string	Number of items per page Default: 25
page_num	string	Page number to retrieve Default: 0
pull_type_only	boolean	Filter by pull type jobs only
push_type_only	boolean	Filter by push type jobs only

GET /vault_rest/jobs/status

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/status' \ --header 'Authorization: Bearer {token}' \ --data page_size=25 \ --data page_num=0 \ --data pull_type_only={pull_type_only} \ --data push_type_only={push_type_only}
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Read All Job Statuses

Retrieves a paginated list of all job statuses across the system.

Auth

Query String

page_size	string	Number of items per page Default: 25
page_num	string	Page number to retrieve Default: 0
pull_type_only	boolean	Filter by pull type jobs only
push_type_only	boolean	Filter by push type jobs only

GET /vault_rest/jobs/all/status

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/all/status' \ --header 'Authorization: Bearer {token}' \ --data page_size=25 \ --data page_num=0 \ --data pull_type_only={pull_type_only} \ --data push_type_only={push_type_only}
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Read Job

Retrieves details of a specific job by ID.

Auth

Path Params

string

Job ID

GET /vault_rest/jobs/{id}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Update Job

Updates an existing job by ID.

Auth

Path Params

string

Job ID

Request Body

object object

PUT /vault_rest/jobs/{id}

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Delete Job

Deletes a specific job by ID.

Auth

Path Params

string

Job ID

DELETE /vault_rest/jobs/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Update Job Transfer Condition

Updates the transfer conditions for a specific job.

Auth

Path Params

string

Job ID

Request Body

object object

PUT /vault_rest/jobs/{id}/transfer_condition

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D/transfer_condition' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Read Job Status

Retrieves the status of a specific job by ID.

Auth

Path Params

string

Job ID

GET /vault_rest/jobs/{id}/status

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D/status' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Execute Job

Manually starts the execution of a specific job.

Auth

Path Params

string

Job ID

POST /vault_rest/jobs/{id}/start

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D/start' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Pause Job

Pauses the execution of a specific job.

Auth

Path Params

string

Job ID

POST /vault_rest/jobs/{id}/pause

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D/pause' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Fork Job

Creates a copy (fork) of an existing job.

Auth

Path Params

string

Job ID

Request Body

object object

POST /vault_rest/jobs/{id}/fork

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D/fork' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Get Jobs Progress

Retrieves the progress of multiple jobs based on the provided request.

Auth

Request Body

object object

POST /vault_rest/jobs/progress

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/jobs/progress' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Job Executions

Job execution history, details, and logs

GET

/vault_rest/jobs/{id}/history

GET

/vault_rest/jobs/all/{id}/history

GET

/vault_rest/jobs/{id}/history/{executionId}

GET

/vault_rest/jobs/all/{id}/history/{executionId}

GET

/vault_rest/jobs/{id}/history/{executionId}/log

GET

/vault_rest/jobs/all/{id}/history/{executionId}/log

GET

/vault_rest/jobs/executions/recent

Read Job Executions

Retrieves a paginated history of executions for a specific job.

Auth

Path Params

string

Job ID

Query String

page_size

string

Number of items per page

Default: 25

page_num

string

Page number to retrieve

Default: 0

GET /vault_rest/jobs/{id}/history

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D/history' \ --header 'Authorization: Bearer {token}' \ --data page_size=25 \ --data page_num=0
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Read All Job Executions

Retrieves a paginated history of all executions for a specific job across the system.

Auth

Path Params

string

Job ID

Query String

page_size

string

Number of items per page

Default: 25

page_num

string

Page number to retrieve

Default: 0

GET /vault_rest/jobs/all/{id}/history

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/all/%7Bid%7D/history' \ --header 'Authorization: Bearer {token}' \ --data page_size=25 \ --data page_num=0
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Read Job Execution

Retrieves details of a specific job execution.

Auth

Path Params

id	string	Job ID
executionId	string	Execution ID

GET /vault_rest/jobs/{id}/history/{executionId}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D/history/%7BexecutionId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Read All Job Execution

Retrieves details of a specific job execution across the system.

Auth

Path Params

id	string	Job ID
executionId	string	Execution ID

GET /vault_rest/jobs/all/{id}/history/{executionId}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/all/%7Bid%7D/history/%7BexecutionId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Download Job Execution Log

Downloads the log file for a specific job execution.

Auth

Path Params

id	string	Job ID
executionId	string	Execution ID

Query String

attachment

boolean

Whether to download as an attachment

GET /vault_rest/jobs/{id}/history/{executionId}/log

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/%7Bid%7D/history/%7BexecutionId%7D/log' \ --header 'Authorization: Bearer {token}' \ --data attachment={attachment}
Copy

Responses

200

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
Copy

Download All Job Execution Log

Downloads the log file for a specific job execution across the system.

Auth

Path Params

id	string	Job ID
executionId	string	Execution ID

Query String

attachment

boolean

Whether to download as an attachment

GET /vault_rest/jobs/all/{id}/history/{executionId}/log

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/all/%7Bid%7D/history/%7BexecutionId%7D/log' \ --header 'Authorization: Bearer {token}' \ --data attachment={attachment}
Copy

Responses

200

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
Copy

Get Recent Job Executions

Retrieves the most recent job executions for the current user.

Auth

GET /vault_rest/jobs/executions/recent

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/executions/recent' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Job Settings

Global configuration and settings for jobs

GET

/vault_rest/jobs/config

POST

/vault_rest/jobs/config

Get Jobs Settings

Retrieves the global configuration settings for jobs.

Auth

GET /vault_rest/jobs/config

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/jobs/config' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Update Jobs Settings

Updates the global configuration settings for jobs.

Auth

Request Body

object object

POST /vault_rest/jobs/config

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/jobs/config' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

MetaDefender Managed File Transfer API - Jobs & Scheduling 3.11.1

Authentication

Jobs

Read Jobs

Create Job

Read Job Statuses

Read All Job Statuses

Read Job

Update Job

Delete Job

Update Job Transfer Condition

Read Job Status

Execute Job

Pause Job

Fork Job

Get Jobs Progress

Job Executions

Read Job Executions

Read All Job Executions

Read Job Execution

Read All Job Execution

Download Job Execution Log

Download All Job Execution Log

Get Recent Job Executions

Job Settings

Get Jobs Settings

Update Jobs Settings

This Website Uses Cookies

Functional Cookies

Performance Cookies

Strictly Necessary Cookies

Targeting Cookies