Api Change Log

What's New

1. DELETE/{client_id}/system/agentgroups/{agent_group_name}/connections Disconnect an agent group
2. DELETE/{client_id}/system/agents/{object_name}/connections Disconnect an agent
3. DELETE/{client_id}/system/usergroups/{group_name}/users Removes all users in query parameter from the group, or nothing (all users needs to exist in group)
4. GET/{client_id}/system/users/{user_name}/tokens Retrieves a list of all tokens generated for a user by their username and client.
5. POST/{client_id}/system/users/{user_name}/tokens Generates a unique token and associates it with the authenticated user.
6. DELETE/{client_id}/system/users/{user_name}/tokens/{tokenName} Deletes a user's token.
7. GET/{client_id}/system/zdu Gets the Zero Downtime Upgrade status.
8. POST/{client_id}/system/zdu Performs an action in the Zero Downtime Upgrade Process.
9. GET/{client_id}/transportcase Exports the currently selected objects in the Transport Case as a Transport Case
10. POST/{client_id}/transportcase Import a transport case

What's Deleted

What's Deprecated

What's Changed

1. GET/{client_id}/system/metrics/prometheus

   • Parameters

     • scrapeIntervalSeconds in query Notes Defines how many seconds in the past to aggregate change into Defines how many seconds in the past to aggregate.
2. DELETE/{client_id}/system/users/{user_name}/connections

   • Parameters

     • user_name in path Notes Name of the object. change into Name of the object.<br><i>Example explanation:</i> USER/DEPT - '/' needs to be encoded as '%2F'
3. POST/{client_id}/executions/{run_id}/comments

   • Request

     • Schema

       Changed body: '*/*'
4. PATCH/{client_id}/folderobjects/{folder_path}/move

   • Parameters

     • folder_path in path Notes Name of the object. change into Name of the object.<br><i>Example explanation:</i> FOLDER/SUBFOLDER - '/' needs to be encoded as '%2F'
5. POST/{client_id}/scripts

   • Request

     • Schema

       Changed body: '*/*'
6. POST/{client_id}/system/agents/{object_name}/rename

   • Request

     • Schema

       Changed body: '*/*'
7. PATCH/{client_id}/system/users/{user}/move

   • Parameters

     • user in path Notes Username to query. Supports wildcards (*). change into Username to query. Supports wildcards (*).<br><i>Example explanation:</i> USER/DEPT - '/' needs to be encoded as '%2F'
8. GET/{client_id}/executions/{run_id}

   • Response

     • Changed response : [200]//successful operation

       • Schema

         Changed body: 'application/json'
9. GET/{client_id}/system/users

   • Parameters

     • name in query Notes Use to filter users by name. change into Use to filter users by name.<br><i>Example explanation:</i> USER/DEPT - '/' needs to be encoded as '%2F'
10. POST/{client_id}/system/users

    • Request

      • Schema incompatible

        Changed body: '*/*'
11. GET/{client_id}/executions

    • Response

      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
12. GET/{client_id}/executions/{run_id}/children

    • Response

      • Changed response : [200]//successful operation

        • Schema

          Changed body: 'application/json'
13. POST/{client_id}/folderobjects

    • Parameters

      • folder_path in query Notes Path of a folder where the objects should be imported. If target folder is empty the root folder is used as target folder. If the target folder does not exist, it will be created. change into Path of a folder where the objects should be imported. If target folder is empty the root folder is used as target folder. If the target folder does not exist, it will be created.<br><i>Example explanation:</i> FOLDER/SUBFOLDER - '/' needs to be encoded as '%2F'

    • Request

      • Schema incompatible

        Changed body: 'application/json'

      • Schema incompatible

        Changed body: 'application/octet-stream'
14. DELETE/{client_id}/folderobjects/{folder_path}

    • Parameters

      • folder_path in path Notes Path to the automation engine target folder that should be deleted. change into Path to the automation engine target folder that should be deleted. <br><i>Example explanation:</i> FOLDER/SUBFOLDER - '/' needs to be encoded as '%2F'
15. PATCH/{client_id}/folderobjects/{folder_path}

    • Parameters

      • folder_path in path Notes Name of the object. change into Name of the object.<br><i>Example explanation:</i> FOLDER/SUBFOLDER - '/' needs to be encoded as '%2F'
16. GET/{client_id}/folderobjects/{folder_path}

    • Parameters

      • folder_path in path Notes Path to the automation engine target folder that should be exported. change into Path to the automation engine target folder that should be exported.<br><i>Example explanation:</i> FOLDER/SUBFOLDER - '/' needs to be encoded as '%2F'

    • Response

      • Changed response : [200]//successful operation

        • Schema incompatible

          Changed body: 'application/octet-stream'
17. POST/{client_id}/objects

    • Request

      • Schema incompatible

        Changed body: 'application/json'
18. GET/{client_id}/objects/{object_name}

    • Response

      • Changed response : [200]//successful operation

        • Schema incompatible

          Changed body: 'application/json'
19. PATCH/{client_id}/objects/{object_name}

    • Request

      • Schema incompatible

        Changed body: 'application/json'