FTP Accounts

Manage FTP-based access to your Stook Buckets.

Retrieve FTP accounts

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The UUID of the organization

Responses
chevron-right
200

FTP accounts retrieved successfully

application/json
get
/api/v2/stook/{organization_uuid}/ftp
200

FTP accounts retrieved successfully

Retrieve FTP account details

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The UUID of the organization

ftp_uuidstringRequired

The UUID of the FTP account

Responses
chevron-right
200

FTP account details retrieved successfully

application/json
get
/api/v2/stook/{organization_uuid}/ftp/{ftp_uuid}
200

FTP account details retrieved successfully

Create a new FTP account

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The UUID of the organization

Body
namestringRequired

The name of the FTP account

passwordstringRequired

The password for the FTP account

bucket_uuidstringRequired

The UUID of the associated bucket

is_readonlybooleanRequired

Indicates if the FTP account is read-only

pathstringRequired

The path for the FTP account

Responses
chevron-right
200

FTP account successfully created

application/json
post
/api/v2/stook/{organization_uuid}/ftp
200

FTP account successfully created

Update FTP account

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The UUID of the organization

ftp_uuidstringRequired

The UUID of the FTP account

Body
passwordstringOptional

The password for the FTP account

login_allowedbooleanOptional

Indicates if login is allowed for the FTP account

pathstringOptional

The path for the FTP account

is_readonlybooleanOptional

Indicates if the FTP account is read-only

Responses
chevron-right
200

FTP account successfully updated

application/json
put
/api/v2/stook/{organization_uuid}/ftp/{ftp_uuid}
200

FTP account successfully updated

Delete an FTP account

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

The UUID of the organization

ftp_uuidstringRequired

The UUID of the FTP account

Responses
chevron-right
200

FTP account successfully deleted

application/json
delete
/api/v2/stook/{organization_uuid}/ftp/{ftp_uuid}
200

FTP account successfully deleted

v1 FTP Endpoints (Legacy)

circle-info

These endpoints belong to Stook API v1. Use the v2 endpoints above for new integrations.

Retrieve FTP account details (v1)

get

Retrieves detailed configuration and access rules for a specific FTP account in the Medianova Control Panel.

Path parameters
organization_uuidstringRequired

Unique identifier for the organization.

ftp_uuidstringRequired

Unique identifier for the FTP account.

Responses
chevron-right
200

Successful response

application/json
get
/api/v1/stook/{organization_uuid}/ftp/{ftp_uuid}
200

Successful response

Update FTP account (v1)

put

Updates the password, access permissions, and IP restriction rules for an existing legacy FTP account in the Medianova Control Panel.

Path parameters
organization_uuidstringRequired

Unique identifier for the organization.

ftp_uuidstringRequired

Unique identifier for the FTP account to be updated.

Body
passwordstringRequired

New password for the FTP account access.

is_readonlybooleanRequired

Sets whether the FTP account has read-only permissions.

pathstringRequired

Storage path to which the FTP account is restricted.

Responses
chevron-right
200

Successful response

application/json
put
/api/v1/stook/{organization_uuid}/ftp/{ftp_uuid}
200

Successful response

Delete FTP account (v1)

delete

Permanently removes an existing legacy FTP account from the specified organization in the Medianova Control Panel.

Path parameters
organization_uuidstringRequired

Unique identifier for the organization.

ftp_uuidstringRequired

Unique identifier for the FTP account to be deleted.

Responses
chevron-right
200

Successful response

application/json
delete
/api/v1/stook/{organization_uuid}/ftp/{ftp_uuid}

Last updated

Was this helpful?