From c7755fe35e2c20d04083b25361b7ef9070854f4e Mon Sep 17 00:00:00 2001 From: Robert Wellon Date: Mon, 23 Oct 2023 16:05:47 -0400 Subject: [PATCH] Create configuration_script_payloads.md --- .../configuration_script_payloads.md | 67 +++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 api/reference/configuration_script_payloads.md diff --git a/api/reference/configuration_script_payloads.md b/api/reference/configuration_script_payloads.md new file mode 100644 index 000000000..b99064a0f --- /dev/null +++ b/api/reference/configuration_script_payloads.md @@ -0,0 +1,67 @@ +--- +--- + +## Configuration Script Payloads + +Management of configuration script payloads is provided through the following +collection: + +``` data +/api/configuration_script_payloads +``` + +The following actions on configuration script payloads are available: + +- [Querying Configuration Script Payloads](#querying-configuration-script-payloads) + +- [Editing Configuration Script Payloads](#editing-configuration-script-payloads) + +- [Updating Configuration Script Payloads](#updating-configuration-script-payloads) + +- [Querying Configuration Script Payload Authentication](#querying-configuration-script-payload-authentication) + +- [Creating Configuration Script Payload Authentication](#creating-configuration-script-payload-authentication) + +### Querying Configuration Script Payloads + +Query all configuration script payloads in the system: + + GET /api/configuration_script_payloads + +Get the details on a specific configuration script payload: + + GET /api/configuration_script_payloads/:id + +### Editing configuration script payloads + +Configuration script payloads can be edited by using a POST to the configuration script payloads collection: + + POST /api/configuration_script_payloads + +### Updating configuration script payloads + +Configuration script payloads can be updated by using a PUT method or PATCH method. + +PUT method: + + PUT /api/configuration_script_payloads/:id + +Patch method: + + PATCH /api/configuration_script_payloads/:id + +### Querying Configuration Script Payload Authentication + +Query the authentication credentials for a specific configuration script payload: + + GET /api/configuration_script_payloads/:id/authentications + +Get the details on a specific authentication credential for a configuration script payload: + + GET /api/configuration_script_payloads/:id/authentications/:id + +### Creating Configuration Script Payload Authentication + +Authentication credentials for a configuration script payload can be created by using a POST to the configuration script payload collection: + + POST /api/configuration_script_payloads/:id/authentications