Services

Creates a service

post

Creates a new service in a team. Learn more about services

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Body

application/json

namestringOptional

descstringOptional

Responses

200

Successful response

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

post

/services/create

HTTPcURLJavaScriptPython

POST /services/create HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "from api",
  "desc": "testing service create from api"
}

{}

Fetch all services

get

Get list of services for a team. Services are scopes for multiple integrations and their incidents. Learn more about services.

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

get

/services

HTTPcURLJavaScriptPython

GET /services HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Fetch incidents for a service

get

Get a list of incidents for a specific service. Returns a list of incidents for a service.

Path parameters

counterIdstringRequired

counterId parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/services/{counterId}/incidents

HTTPcURLJavaScriptPython

GET /services/{counterId}/incidents HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Fetch integrations of a service

get

Get a list of integrations for a specific service. Includes all the integrations for a service with their details and webhook.

Path parameters

counterIdstringRequired

counterId parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/services/{counterId}/integrations

HTTPcURLJavaScriptPython

GET /services/{counterId}/integrations HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Fetch service details with incidents

get

Get details of a service with it's incidents. Services are scopes for multiple integrations and their incidents. This route also returns the list of incidents for a service.

Path parameters

counterIdstringRequired

counterId parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/services/{counterId}

HTTPcURLJavaScriptPython

GET /services/{counterId} HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Fetch currently affected services

get

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

get

/services/affected

HTTPcURLJavaScriptPython

GET /services/affected HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Updates a service

put

Update your service name and description only

Path parameters

counterIdstringRequired

counterId parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Body

application/json

namestringOptional

descstringOptional

Responses

200

Successful response

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

put

/services/{counterId}/update

HTTPcURLJavaScriptPython

PUT /services/{counterId}/update HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "name": "updated from api",
  "desc": "some desc"
}

{}