FTP Accounts

Manage FTP-based access to your Stook Buckets.

Retrieve FTP accounts

get

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organization_uuidstringRequired

The UUID of the organization

Responses

200

FTP accounts retrieved successfully

application/json

statusbooleanOptional

Indicates the success of the request

get

/api/v2/stook/{organization_uuid}/ftp

HTTPcURLJavaScriptPython

GET /api/api/v2/stook/{organization_uuid}/ftp HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

FTP accounts retrieved successfully

{
  "status": true,
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "bucket_uuid": "text",
      "path": "text",
      "login_allowed": true,
      "is_readonly": true,
      "wrap_rules": [
        {
          "type": "allow",
          "rule": [
            "text"
          ]
        }
      ]
    }
  ]
}

Retrieve FTP account details

get

Authorizations

Bearer

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

200

FTP account details retrieved successfully

application/json

statusbooleanOptional

Indicates the success of the request

get

/api/v2/stook/{organization_uuid}/ftp/{ftp_uuid}

HTTPcURLJavaScriptPython

GET /api/api/v2/stook/{organization_uuid}/ftp/{ftp_uuid} HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

FTP account details retrieved successfully

{
  "status": true,
  "data": {
    "uuid": "text",
    "bucket_uuid": "text",
    "name": "text",
    "path": "text",
    "login_allowed": true,
    "count": 1,
    "is_readonly": true,
    "wrap_rules": [
      {
        "type": "allow",
        "rule": [
          "text"
        ]
      }
    ]
  }
}

Create a new FTP account

post

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organization_uuidstringRequired

The UUID of the organization

Body

application/json

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

200

FTP account successfully created

application/json

statusbooleanOptional

Indicates the success of the request

post

/api/v2/stook/{organization_uuid}/ftp

HTTPcURLJavaScriptPython

POST /api/api/v2/stook/{organization_uuid}/ftp HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "name": "text",
  "password": "text",
  "bucket_uuid": "text",
  "is_readonly": true,
  "path": "text",
  "wrap_rules": [
    {
      "type": "allow",
      "rule": [
        "text"
      ]
    }
  ]
}

200

FTP account successfully created

{
  "status": true,
  "data": {
    "uuid": "text",
    "bucket_uuid": "text",
    "name": "text",
    "path": "text",
    "login_allowed": true,
    "count": 1,
    "is_readonly": true,
    "wrap_rules": [
      {
        "type": "allow",
        "rule": [
          "text"
        ]
      }
    ]
  }
}

Update FTP account

put

Authorizations

Bearer

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

application/json

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

200

FTP account successfully updated

application/json

statusbooleanOptional

Indicates the success of the request

put

/api/v2/stook/{organization_uuid}/ftp/{ftp_uuid}

HTTPcURLJavaScriptPython

PUT /api/api/v2/stook/{organization_uuid}/ftp/{ftp_uuid} HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "password": "text",
  "login_allowed": true,
  "path": "text",
  "is_readonly": true,
  "wrap_rules": [
    {
      "type": "allow",
      "rule": [
        "text"
      ]
    }
  ]
}

200

FTP account successfully updated

{
  "status": true,
  "data": {
    "uuid": "text",
    "bucket_uuid": "text",
    "name": "text",
    "path": "text",
    "login_allowed": true,
    "count": 1,
    "is_readonly": true,
    "wrap_rules": [
      {
        "type": "allow",
        "rule": [
          "text"
        ]
      }
    ]
  }
}

Delete an FTP account

delete

Authorizations

Bearer

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

200

FTP account successfully deleted

application/json

statusbooleanOptional

Indicates the success of the request

datastringOptional

Message indicating the result of the operation

delete

/api/v2/stook/{organization_uuid}/ftp/{ftp_uuid}

HTTPcURLJavaScriptPython

DELETE /api/api/v2/stook/{organization_uuid}/ftp/{ftp_uuid} HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

FTP account successfully deleted

{
  "status": true,
  "data": "text"
}

v1 FTP Endpoints (Legacy)

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

200

Successful response

application/json

statusbooleanOptional

Indicates whether the request was successful.

get

/api/v1/stook/{organization_uuid}/ftp/{ftp_uuid}

HTTPcURLJavaScriptPython

GET /api/api/v1/stook/{organization_uuid}/ftp/{ftp_uuid} HTTP/1.1
Host: cloud.medianova.com
Accept: */*

200

Successful response

{
  "status": true,
  "data": {
    "uuid": "text",
    "name": "text",
    "path": "text",
    "is_readonly": true,
    "wrap_rules": [
      {
        "type": "allow",
        "rule": [
          "text"
        ]
      }
    ]
  }
}

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

application/json

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

200

Successful response

application/json

statusbooleanOptional

Indicates whether the FTP account update was successful.

put

/api/v1/stook/{organization_uuid}/ftp/{ftp_uuid}

HTTPcURLJavaScriptPython

PUT /api/api/v1/stook/{organization_uuid}/ftp/{ftp_uuid} HTTP/1.1
Host: cloud.medianova.com
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "password": "text",
  "is_readonly": true,
  "path": "text",
  "wrap_rules": [
    {
      "type": "allow",
      "rule": [
        "text"
      ]
    }
  ]
}

200

Successful response

{
  "status": true,
  "data": {
    "uuid": "text",
    "name": "text",
    "path": "text",
    "is_readonly": true
  }
}

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

200

Successful response

application/json

statusbooleanOptional

Indicates whether the FTP account deletion was successful.

404

FTP account not found

delete

/api/v1/stook/{organization_uuid}/ftp/{ftp_uuid}

HTTPcURLJavaScriptPython

DELETE /api/api/v1/stook/{organization_uuid}/ftp/{ftp_uuid} HTTP/1.1
Host: cloud.medianova.com
Accept: */*

{
  "status": true
}