Skip to main content

Update Service

PATCH /api/v1/services/:serviceId

Description

Update service information including its name, API key rotation settings, bio, actionBy, and configurations.

URL:

  • Raw URL: /api/v1/services/:serviceId
  • Host:
  • Path: /api/v1/services/:serviceId
  • Variables:
    • serviceId: (Required)

Request:

  • Headers:
    • Content-Type: application/json

Response:

  • Status: OK (200)
/api/v1/services/:serviceId

Headers

Content-TypeValue
Content-Typeapplication/json

Auth: Bearer Token {{tenantUserAccessToken}}

Body (raw)

{
"name": "<string>",
"apiKeyRotationPeriod": "HOURS",
"apiKeyRotationValue": "<number>",
"apiKeyRotationCustomDate": {},
"bio": {
"title": "<string>",
"description": "<string>",
"photo": "<string>"
},
"actionBy": "<string>",
"config": [
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "array-string",
"formType": "select",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
},
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "string",
"formType": "select",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
}
]
}

Response: 200

{
"_id": "{{$randomId}}",
"code": "operations",
"__v": 0,
"config": [
{
"label": "luka Label",
"key": "ylabel",
"required": true,
"value": "string",
"valueType": "string",
"formType": "input",
"_id": "{{$randomId}}",
"formOptions": []
},
{
"label": "Laka label",
"key": "thslabel",
"required": true,
"value": "string",
"valueType": "string",
"formType": "input",
"_id": "{{$randomId}}",
"formOptions": []
}
],
"createdAt": "{{$timestamp}}",
"createdBy": "SYSTEM",
"deleted": false,
"deletedBy": null,
"display": "PUBLIC",
"name": "Operations",
"overview": "DEDE",
"requirements": ["THANKS", "THANKS22"],
"rotationPeriod": "HOURS",
"rotationValue": 6283,
"updatedAt": "{{$timestamp}}",
"updatedBy": null,
"urlIdentity": "https://samantha.biz",
"bio": {}
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PATCH \ 
--url /api/v1/services/:serviceId \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!