Sign in

v1

latestOpenAPI 3.0.12026-07-13149396412.1 KB
ResourcePools

put/api/v1/config/resource-pools

Request body

create_if_missingboolean

If true, the ResourcePools will be created if it does not already exist. If false, an error will be returned if the ResourcePools does not already exist.

dry_runboolean

If true, the ResourcePools isn't created or updated, and no response ResourcePools will be returned. The response will return an error if the given ResourcePools is invalid.

Example request

{
  "resource_pools": {
    "default_pool": {
      "priorities": {
        "high_priority_filters": [
          {
            "name": "job",
            "value_glob": "myservice*"
          }
        ],
        "low_priority_filters": [
          {
            "name": "job",
            "value_glob": "myservice*"
          }
        ]
      }
    },
    "pools": [
      {
        "filters": [
          {
            "name": "job",
            "value_glob": "myservice*"
          }
        ],
        "priorities": {
          "high_priority_filters": [
            {
              "name": "job",
              "value_glob": "myservice*"
            }
          ],
          "low_priority_filters": [
            {
              "name": "job",
              "value_glob": "myservice*"
            }
          ]
        }
      }
    ]
  }
}

Response

A successful response containing the updated ResourcePools.

Example response

{
  "resource_pools": {
    "default_pool": {
      "priorities": {
        "high_priority_filters": [
          {
            "name": "job",
            "value_glob": "myservice*"
          }
        ],
        "low_priority_filters": [
          {
            "name": "job",
            "value_glob": "myservice*"
          }
        ]
      }
    },
    "pools": [
      {
        "filters": [
          {
            "name": "job",
            "value_glob": "myservice*"
          }
        ],
        "priorities": {
          "high_priority_filters": [
            {
              "name": "job",
              "value_glob": "myservice*"
            }
          ],
          "low_priority_filters": [
            {
              "name": "job",
              "value_glob": "myservice*"
            }
          ]
        }
      }
    ]
  }
}