Sets a new state for an organization

Sets a new state for an organization and creates an organization state
history record. An organization can be set to active or inactive.

post
https://global.api.konghq.com/v3/organizations/state

Body

application/json

The request schema to set an organization’s state.

statestringrequired

The state of the organization to set.

Allowed values:activeinactivedeletingdeleted

Example:inactive

reasonstring

The reason for the state change.

Example:invoice overdue (30 days)

changed_bystring

The uuid of the konger who modified the state.

Example:00uerwcs8eC4ifanR256

Response

application/json

A response for setting the organization state.

Organization State

idstring(uuid)read-only

UUID of the organization.

Example:d99c041a-c7cf-46a2-bf3a-44bb5f75400e

statestring

State of the organization.

Allowed values:activeinactivedeletingdeleted

Example:active

reasonstring

The reason for the organization’s state.

Example:invoice overdue (30 days)

servicestring

The service that modified the state.

Example:kbilling

changed_bystring

The ID of the Konger who modified the state.

Example:00uerwcs8eC4ifanR256

created_atstring(date-time)read-only

Date the organization state was created.

Example:2023-01-23T17:22:52.150Z

post/organizations/state

Body

{ "state": "inactive", "reason": "invoice overdue (30 days)", "changed_by": "00uerwcs8eC4ifanR256" }
 
application/json

Get the state history of an organization

Returns the state history of an organization sorted in reverse chronological order.
Possible states include active, inactive, deleting, and deleted. An organization state
will be transitioned to the deleting state if the organization remains inactive for 90 days.
After deletion is complete, the state will be transitioned to the final deleted state.

get
https://global.api.konghq.com/v3/organizations/state/history

Response

application/json

A paginated list response for a collection of organization state changes.

Organizations State History.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]
Show Child Parameters
get/organizations/state/history
 
application/json

Update Deletion Config

Sets the deletion configs for a specified organization. The retention period
is the number of days an organization can remain in the inactive state before
being permanently deleted.

patch
https://global.api.konghq.com/v3/organizations/{organizationId}/deletion-config

Path Parameters

organizationIdstring(uuid)required

The ID of the organization being patched.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

The request schema to set an organization’s retention period.

Deletion Config

retention_period_daysinteger

The retention period in days.

>= 1<= 365

Example:90

Response

application/json

The response schema for setting an organization’s retention period.

Deletion Config

retention_period_daysinteger

The retention period in days.

>= 1<= 365

Example:90

patch/organizations/{organizationId}/deletion-config

Body

{ "retention_period_days": 90 }
 
application/json

Organization State

object
idstring(uuid)read-only

UUID of the organization.

Example:d99c041a-c7cf-46a2-bf3a-44bb5f75400e

statestring

State of the organization.

Allowed values:activeinactivedeletingdeleted

Example:active

reasonstring

The reason for the organization’s state.

Example:invoice overdue (30 days)

servicestring

The service that modified the state.

Example:kbilling

changed_bystring

The ID of the Konger who modified the state.

Example:00uerwcs8eC4ifanR256

created_atstring(date-time)read-only

Date the organization state was created.

Example:2023-01-23T17:22:52.150Z

Example

Deletion Config

object
retention_period_daysinteger

The retention period in days.

>= 1<= 365

Example:90

Example