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
Root Schema : Organization
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
custom_virtualenv:
string
Title:
Custom virtualenv
Read Only:true
Minimum Length:1
Local absolute file path containing a custom Python virtualenv to use -
default_environment:
integer
Title:
Default environment
The default execution environment for jobs run by this organization. -
description:
string
Title:
Description
-
id:
integer
Title:
ID
Read Only:true
-
max_hosts:
integer
Title:
Max hosts
Minimum Value:0
Maximum number of hosts allowed to be managed by this organization. -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
- related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
Response
Supported Media Types
- application/json
200 Response
Root Schema : Organization
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
custom_virtualenv:
string
Title:
Custom virtualenv
Read Only:true
Minimum Length:1
Local absolute file path containing a custom Python virtualenv to use -
default_environment:
integer
Title:
Default environment
The default execution environment for jobs run by this organization. -
description:
string
Title:
Description
-
id:
integer
Title:
ID
Read Only:true
-
max_hosts:
integer
Title:
Max hosts
Minimum Value:0
Maximum number of hosts allowed to be managed by this organization. -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
- related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true