V-Spark Online Help

Create a Folder with POST and /config

The following is an example workflow for using POST with /config to create or modify a folder:

  1. Acquire the authorization token, along with the company and organization short names for the folder to be created or modified. The following must be supplied with any POST call to /config:

    Token

    A company token with write permissions for the target organization. Refer to V‑Spark API Permission RequirementsV-Spark API Permission Requirements for more information about V‑Spark API tokens.

    Company short name

    The reference configured for a company when it is first created. Click Settings > Accounts to view the list of company short names in the Company section of the Accounts Settings screen.

    Organization short name

    The reference configured for an organization when it is first created. Click Settings > Accounts to view the list of organization short names in the Organization section of the Accounts Settings screen.

    Company and organization information may also retrieved using GET with /config. Refer to Using GET with cURL and the /config API and Using GET with Python and the /config API for more information.

  2. Prepare a JSON file with the folder's configuration parameters. Using POST to create folders with the /config endpoint requires the configuration of many folder properties; as a result, it is strongly recommended to POST a JSON file with the folder's required properties.

    Refer to Sample /config/folders JSON Output for a Folder for the information required to assemble a folder configuration JSON file.

  3. Make a POST request to the /config endpoint with the JSON file as a parameter. Refer to the following topics for more information:

  4. If the folder exists, its configuration is changed to the submitted parameters. If the folder does not exist, it is created with the submitted parameters.

  5. Verify the folder's configuration using the Monitored Folders UI or a GET request to the /config endpoint. Refer to the following topics for more information: