Update a service

patch

https://api.firehydrant.io/v1/services/{service_id}

Update a services attributes, you may also add or remove functionalities from the service as well. Note: You may not remove or add individual label key/value pairs. You must include the entire object to override label values.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

service_id

string

required

Body Params

alert_on_add

boolean | null

auto_add_responding_team

boolean | null

checklists

array of objects | null

Array of checklist IDs to attach to the service

checklists

description

string | null

external_resources

array of objects | null

An array of external resources to attach to this service.

external_resources

functionalities

array of objects | null

An array of functionalities

functionalities

remove_remaining_functionalities

boolean | null

If set to true, any functionalities tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the functionalities

environments

array of objects | null

environments

remove_remaining_environments

boolean | null

Defaults to false

Set this to true if you want to remove all of the environments that are not included in the environments array from the service

labels

object | null

A hash of label keys and values

links

array of objects | null

An array of links to associate with this service. This will remove all links not present in the patch. Only acts if 'links' key is included in the payload.

links

name

string | null

owner

object | null

An object representing a Team that owns the service

remove_owner

boolean | null

If you are trying to remove a team as an owner from a service, set this to 'true'

remove_remaining_checklists

boolean | null

If set to true, any checklists tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the checklists

remove_remaining_external_resources

boolean | null

If set to true, any external_resources tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the external_resources

remove_remaining_teams

boolean | null

If set to true, any teams tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the teams

service_tier

int32 | null

enum

Integer representing service tier

Allowed:

teams

array of objects | null

An array of teams to attach to this service.

teams

Response

200Update a services attributes, you may also add or remove functionalities from the service as well. Note: You may not remove or add individual label key/value pairs. You must include the entire object to override label values.