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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The file contents.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : configViewConfigsReadFile
Type:
Show Source
object
-
FileContents: string
File Contents having Configuration detailsExample:
localhost:server.com
-
FileName: string
File NameExample:
file.conf
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object