Skip to content

Commit

Permalink
Create configuration_script_payloads.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rwellon committed Oct 23, 2023
1 parent 27cba52 commit c7755fe
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions api/reference/configuration_script_payloads.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit c7755fe

Please sign in to comment.