Skip to main content

Create a new service

POST /api/v1/services

Description

Create a new service with the specified information, including its name, API key rotation settings, bio, actionBy, configurations, URL identity, and callback URL.

URL:

  • Raw URL: /api/v1/services

  • Host:

  • Path: /api/v1/services

Headers

Content-TypeValue
service-registration-keystring
Content-Typeapplication/json

Auth: Bearer Token {{tenantUserAccessToken}}

Body (raw)

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

Response: 201

{
"message": "Service Creation Acknowledge",
"code": "{{$randomCode}}",
"apiKey": "{{$randomApiKey}}"
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


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

RESPONSE


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