Monitors

Set a new monitor status.

Set monitor status.

put/fleets/{fid}/monitors/{mid}/status

Request

Base URL
https://api-cert.groupe-psa.com/connectedcar/v3
Auth
HTTP basic and API key in query parameter client_id
TypeScript
https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/docs/fleets/:fid/monitors/:mid/status/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

fidstring required

Resource is related to this fleet ID only.

midstring required

id of the monitor.

Request body

status'Running' | 'Paused' required

Example request

{
  "status": "Paused"
}

Response

Monitor created or updated successfully

createdAtstring date-time required

Date when the resource has been created.

updatedAtstring date-time required

monitorIdstring required

Uniq monitor ID returned when the monitor was created succefully.

status'Running' | 'Paused' | 'Failed' required

Example response

{
  "_links": {
    "fleet": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "monitor": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.