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

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

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

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

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

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.

v1/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

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
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

FTP account details retrieved successfully

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

v1/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

is_readonlybooleanRequired

Indicates if the FTP account is read-only

passwordstringRequired

The password for the FTP account

pathstringRequired

The path for the FTP account

Responses

200

FTP account successfully updated

application/json

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
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

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

200

FTP account successfully updated

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

v1/Delete 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

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
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

FTP account successfully deleted

{
  "status": true
}