Jump to

• Request
• Response

Create a Device Configuration Action

post

/api/config/Actions

Creates a new device configuration action.
The minimum required properties in the request body are:

• ActionName
• Actions
• ResultTimeout

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionName: string
  The action name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: Example Action Name
• Actions: array Actions
• ResultTimeout: integer
  The timeout for all commands.

  Example: 30

{
    "properties":{
        "ActionName":{
            "description":"The action name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Example Action Name"
        },
        "ResultTimeout":{
            "description":"The timeout for all commands.",
            "type":"integer",
            "example":"30"
        },
        "Actions":{
            "$ref":"#/components/schemas/Actions"
        }
    }
}

Nested Schema : Actions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ActionOrder":{
                "description":"The 0-based order to run commands.",
                "type":"integer",
                "example":1
            },
            "ConfigActionProfileID":{
                "description":"The ID linking the action back to the parent actions profile.",
                "type":"integer",
                "example":2
            },
            "DisplayActionOutput":{
                "description":"Whether to save the output of a command or not.",
                "type":"boolean",
                "example":0
            },
            "ReadAction":{
                "description":"For Telnet actions only. The prompt to use before running the command. The default is <b>#</b>.",
                "type":"string",
                "example":"Example Read Action"
            },
            "WriteAction":{
                "description":"The command to run.",
                "type":"string",
                "example":"Example Write Action"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ActionOrder: integer
  The 0-based order to run commands.

  Example: 1
• ConfigActionProfileID: integer
  The ID linking the action back to the parent actions profile.

  Example: 2
• DisplayActionOutput: boolean
  Whether to save the output of a command or not.

  Example: 0
• ReadAction: string
  For Telnet actions only. The prompt to use before running the command. The default is #.

  Example: Example Read Action
• WriteAction: string
  The command to run.

  Example: Example Write Action

{
    "type":"object",
    "properties":{
        "ActionOrder":{
            "description":"The 0-based order to run commands.",
            "type":"integer",
            "example":1
        },
        "ConfigActionProfileID":{
            "description":"The ID linking the action back to the parent actions profile.",
            "type":"integer",
            "example":2
        },
        "DisplayActionOutput":{
            "description":"Whether to save the output of a command or not.",
            "type":"boolean",
            "example":0
        },
        "ReadAction":{
            "description":"For Telnet actions only. The prompt to use before running the command. The default is <b>#</b>.",
            "type":"string",
            "example":"Example Read Action"
        },
        "WriteAction":{
            "description":"The command to run.",
            "type":"string",
            "example":"Example Write Action"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new device configuration action.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/configActionsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

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

  Example: true

{
    "description":"The response body for a successful add operation.",
    "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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new device configuration action.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new device configuration action.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/configActionsRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new device configuration action.

Show Source

• Array of: object configActionsRead

{
    "description":"The properties of the new device configuration action.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/configActionsRead"
    }
}

Nested Schema : configActionsRead

Type: object

Show Source

• ActionCount: integer
  The number of actions to be executed.

  Example: 1
• ActionName: string
  The descriptor for the group of actions to be run.

  Example: Example Action Name
• Actions: array Actions
• ConfigActionProfileID: integer
  The configuration action profile ID.

  Example: 1001
• ResultTimeout: integer
  The timeout for all commands.

  Example: 30

{
    "type":"object",
    "properties":{
        "ActionCount":{
            "description":"The number of actions to be executed.",
            "type":"integer",
            "example":"1"
        },
        "ActionName":{
            "description":"The descriptor for the group of actions to be run.",
            "type":"string",
            "example":"Example Action Name"
        },
        "Actions":{
            "$ref":"#/components/schemas/Actions"
        },
        "ConfigActionProfileID":{
            "description":"The configuration action profile ID.",
            "type":"integer",
            "example":"1001"
        },
        "ResultTimeout":{
            "description":"The timeout for all commands.",
            "type":"integer",
            "example":"30"
        }
    }
}

Nested Schema : Actions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ActionOrder":{
                "description":"The 0-based order to run commands.",
                "type":"integer",
                "example":1
            },
            "ConfigActionProfileID":{
                "description":"The ID linking the action back to the parent actions profile.",
                "type":"integer",
                "example":2
            },
            "DisplayActionOutput":{
                "description":"Whether to save the output of a command or not.",
                "type":"boolean",
                "example":0
            },
            "ReadAction":{
                "description":"For Telnet actions only. The prompt to use before running the command. The default is <b>#</b>.",
                "type":"string",
                "example":"Example Read Action"
            },
            "WriteAction":{
                "description":"The command to run.",
                "type":"string",
                "example":"Example Write Action"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ActionOrder: integer
  The 0-based order to run commands.

  Example: 1
• ConfigActionProfileID: integer
  The ID linking the action back to the parent actions profile.

  Example: 2
• DisplayActionOutput: boolean
  Whether to save the output of a command or not.

  Example: 0
• ReadAction: string
  For Telnet actions only. The prompt to use before running the command. The default is #.

  Example: Example Read Action
• WriteAction: string
  The command to run.

  Example: Example Write Action

{
    "type":"object",
    "properties":{
        "ActionOrder":{
            "description":"The 0-based order to run commands.",
            "type":"integer",
            "example":1
        },
        "ConfigActionProfileID":{
            "description":"The ID linking the action back to the parent actions profile.",
            "type":"integer",
            "example":2
        },
        "DisplayActionOutput":{
            "description":"Whether to save the output of a command or not.",
            "type":"boolean",
            "example":0
        },
        "ReadAction":{
            "description":"For Telnet actions only. The prompt to use before running the command. The default is <b>#</b>.",
            "type":"string",
            "example":"Example Read Action"
        },
        "WriteAction":{
            "description":"The command to run.",
            "type":"string",
            "example":"Example Write Action"
        }
    }
}

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":{
                "description":"An error.",
                "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
  An error.

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

Nested Schema : items

Type: object

An error.

Back to Top