|
| 1 | +--- |
| 2 | +--- |
| 3 | + |
| 4 | +## Configuration Script Payloads |
| 5 | + |
| 6 | +Management of configuration script payloads is provided through the following |
| 7 | +collection: |
| 8 | + |
| 9 | +``` data |
| 10 | +/api/configuration_script_payloads |
| 11 | +``` |
| 12 | + |
| 13 | +The following actions on configuration script payloads are available: |
| 14 | + |
| 15 | +- [Querying Configuration Script Payloads](#querying-configuration-script-payloads) |
| 16 | + |
| 17 | +- [Editing Configuration Script Payloads](#editing-configuration-script-payloads) |
| 18 | + |
| 19 | +- [Updating Configuration Script Payloads](#updating-configuration-script-payloads) |
| 20 | + |
| 21 | +- [Querying Configuration Script Payload Authentication](#querying-configuration-script-payload-authentication) |
| 22 | + |
| 23 | +- [Creating Configuration Script Payload Authentication](#creating-configuration-script-payload-authentication) |
| 24 | + |
| 25 | +### Querying Configuration Script Payloads |
| 26 | + |
| 27 | +Query all configuration script payloads in the system: |
| 28 | + |
| 29 | + GET /api/configuration_script_payloads |
| 30 | + |
| 31 | +Get the details on a specific configuration script payload: |
| 32 | + |
| 33 | + GET /api/configuration_script_payloads/:id |
| 34 | + |
| 35 | +### Editing configuration script payloads |
| 36 | + |
| 37 | +Configuration script payloads can be edited by using a POST to the configuration script payloads collection: |
| 38 | + |
| 39 | + POST /api/configuration_script_payloads |
| 40 | + |
| 41 | +### Updating configuration script payloads |
| 42 | + |
| 43 | +Configuration script payloads can be updated by using a PUT method or PATCH method. |
| 44 | + |
| 45 | +PUT method: |
| 46 | + |
| 47 | + PUT /api/configuration_script_payloads/:id |
| 48 | + |
| 49 | +Patch method: |
| 50 | + |
| 51 | + PATCH /api/configuration_script_payloads/:id |
| 52 | + |
| 53 | +### Querying Configuration Script Payload Authentication |
| 54 | + |
| 55 | +Query the authentication credentials for a specific configuration script payload: |
| 56 | + |
| 57 | + GET /api/configuration_script_payloads/:id/authentications |
| 58 | + |
| 59 | +Get the details on a specific authentication credential for a configuration script payload: |
| 60 | + |
| 61 | + GET /api/configuration_script_payloads/:id/authentications/:id |
| 62 | + |
| 63 | +### Creating Configuration Script Payload Authentication |
| 64 | + |
| 65 | +Authentication credentials for a configuration script payload can be created by using a POST to the configuration script payload collection: |
| 66 | + |
| 67 | + POST /api/configuration_script_payloads/:id/authentications |
0 commit comments