Jump to

• Request
• Response

Get File Contents for Specified Configuration

get

/api/config/ViewConfigs/readFile

Gets the file contents for the specified configuration.

Request

Query Parameters

• ConfigCollectionID(required): integer
  The configuration collection ID. Provide either ConfigCollectionName or ConfigCollectionID, but not both.

  Example:

  1001

• ConfigCollectionName(required): string
  The configuration collection name. Provide either ConfigCollectionName or ConfigCollectionID, but not both.

  Example:

  SSH Actions

• ToRevision(required): integer(int32)
  The revision number to stop the action at.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The file contents.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/configViewConfigsReadFile"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The file contents.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The file contents.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/configViewConfigsReadFile"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The file contents.

Show Source

• Array of: object configViewConfigsReadFile

{
    "description":"The file contents.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/configViewConfigsReadFile"
    }
}

Nested Schema : configViewConfigsReadFile

Type: object

Show Source

• FileContents: string
  File Contents having Configuration details

  Example: localhost:server.com
• FileName: string
  File Name

  Example: file.conf

{
    "properties":{
        "FileName":{
            "description":"File Name",
            "type":"string",
            "example":"file.conf"
        },
        "FileContents":{
            "description":"File Contents having Configuration details",
            "type":"string",
            "example":"localhost:server.com"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top