Jump to

• Request
• Response

Update an Organization

patch

/api/v2/organizations/{id}/

Make a PUT or PATCH request to this resource to update this organization. The following fields may be modified:

• name: Name of this organization. (string, required)
• description: Optional description of this organization. (string, default="")

• max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer, default=0)

• default_environment: The default execution environment for jobs run by this organization. (id, default=``)

For a PATCH request, include only the fields that are being modified.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Query Parameters

• search: string
  A search term.

Body ()

Root Schema : schema

Type: object

Show Source

• default_environment: integer
  The default execution environment for jobs run by this organization.
• description: string
• max_hosts: integer
  Maximum number of hosts allowed to be managed by this organization.
• name: string

{
    "properties":{
        "default_environment":{
            "description":"The default execution environment for jobs run by this organization.",
            "type":"integer"
        },
        "description":{
            "description":"",
            "type":"string"
        },
        "max_hosts":{
            "description":"Maximum number of hosts allowed to be managed by this organization.",
            "type":"integer"
        },
        "name":{
            "description":"",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

200 Response

Back to Top