GET get_ftp_configuration

Description

This route will retrieve an ftp configuration.

Request

HTTP Verb: GET

/get_ftp_configuration/<id_type>/<id>

Dynamic URL segments

• id_type

  what type of id you would like to use to retrieve the ftp configuration. Allowed values are: ftp_id, server_id or cp_id (city_project_id).

• id

  the id (Primary key) of the row you would like to retrieve.

Headers

• Authorization header

  the request must include a header authorization. Its value must be the API key you have been given. Every key has access to all get routes and ownership of rows is not enforced.

Response

Data

If the request succeeds the API will respond with an ftp_configuration JSON object of the following shape:

{
    "id": number, 
    "schematic_path": string | null, 
    "address": string, 
    "port": number, 
    "is_ftp": number, (literally why is this not a boolean) 
    "username": string, 
    "password": string  
} 

Status Codes

• 200 Ok

  This status code will be returned if the request suceeds. It will always be sent along with the response data.

• 400 Bad Request

  This status code will be returned if either the auth header is missing or id_type is not one of the allowed values.

• 401 Unauthorized

  This status code will be returned if the API key is invalid