Jump to

• Request
• Response

Get all Services

get

{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services

List all the available services

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : services

Type: object

Describes status of all services.

Show Source

• services: array services

{
    "type":"object",
    "properties":{
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceStatus"
            }
        }
    },
    "description":"Describes status of all services.",
    "xml":{
        "name":"services"
    }
}

Nested Schema : services

Type: array

Show Source

• Array of: object services
  Describes status of given service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceStatus"
    }
}

Nested Schema : services

Type: object

Describes status of given service.

Show Source

• activationError: string
  Read Only: true

  Activation error description, if service is in FAILD state
• serviceType: string
  Allowed Values: [ "sftp" ]

  Service name
• status: string
  Allowed Values: [ "RUNNING", "STOPPED", "STARTING", "SHUTTING DOWN", "FAILED" ]

  Activation Status

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "description":"Service name",
            "enum":[
                "sftp"
            ]
        },
        "status":{
            "type":"string",
            "description":"Activation Status",
            "enum":[
                "RUNNING",
                "STOPPED",
                "STARTING",
                "SHUTTING DOWN",
                "FAILED"
            ]
        },
        "activationError":{
            "type":"string",
            "description":"Activation error description, if service is in FAILD state",
            "readOnly":true
        }
    },
    "description":"Describes status of given service.",
    "xml":{
        "name":"services"
    }
}

401 Response

Unauthorized

404 Response

Service not found

500 Response

Internal Server Error

Back to Top