We are currently transitioning our API documentation to Apidog and making changes to improve standardization, and as such, methods are subject to change.

Anomify API

/org

Designing

PUT

/org

Last modified:2024-09-26 12:40:33

Update information for an organization.
All parameters are optional.

Request

Body Params application/x-www-form-urlencoded

name

string

optional

The name of your organization. Example: My Org Name.

timezone

string

optional

A valid ISO timezone name. Example: Europe/London.

slack_api_token

string

optional

A Slack API token which allows posting to your Slack instance and specified channels. Example: aaa-bbb-ccc-ddd.

retention_1_resolution_seconds

string

optional

TBC. Example: 60.

retention_1_period_seconds

string

optional

TBC. Example: 604800.

retention_2_resolution_seconds

string

optional

TBC. Example: 600.

retention_2_period_seconds

string

optional

TBC. Example: 63072000.

default_data_frequency_seconds

string

optional

TBC. Example: 60.

default_analysis_period_1_seconds

string

optional

TBC. Example: 86400.

default_analysis_period_2_seconds

string

optional

TBC. Example: 86400.

long_term_pattern_length_seconds

string

optional

TBC. Example: 2592000.

admin_email_alert_users

string

optional

A list of ids for users who want to receive admin alerts by email. Example: 101,102,103

admin_sms_alert_users

string

optional

A list of ids for users who want to receive admin alerts by SMS. Example: 101,102,103

mute_alerts_for_minutes

string

optional

A number of minutes to mute alerts for, starting when the setting is updated. Example: 60.

admin_users

string

optional

A list of all admin users. Example: 101,102.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/org' \
--data-urlencode 'name=' \
--data-urlencode 'timezone=' \
--data-urlencode 'slack_api_token=' \
--data-urlencode 'retention_1_resolution_seconds=' \
--data-urlencode 'retention_1_period_seconds=' \
--data-urlencode 'retention_2_resolution_seconds=' \
--data-urlencode 'retention_2_period_seconds=' \
--data-urlencode 'default_data_frequency_seconds=' \
--data-urlencode 'default_analysis_period_1_seconds=' \
--data-urlencode 'default_analysis_period_2_seconds=' \
--data-urlencode 'long_term_pattern_length_seconds=' \
--data-urlencode 'admin_email_alert_users=' \
--data-urlencode 'admin_sms_alert_users=' \
--data-urlencode 'mute_alerts_for_minutes=' \
--data-urlencode 'admin_users='

Responses

🟢200An example Response

application/json

Body

status

object (API Response Status)

required

created_timestamp

integer

required

Response created timestamp

created_string

string

required

Response created date/time string

duration

number

required

Duration of response, seconds

language

string

required

Language

timezone

object (Timezone)

required

code

enum<integer>

required

Response code, following HTTP status spec

Allowed values:

200202203204307400401404418500501

oldest_cached_component_age

integer

required

Age in seconds of oldest cached component

session_id

string

required

Session id

org_onboarding_status_id

integer | null

required

Org onboarding status id

api_host

string | null

required

API host

user_onboarding_flags

object (User Onboarding Flags)

optional

org_upgraded

integer | boolean

required

data

object

required

org

object (Organization)

required

Example

{}

Modified at 2024-09-26 12:40:33

/org/adminalerts