Services

This contains APIs related to Services

Create a Service

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

Details of the Service to be created

identifier
string

Identifier of the Service Request.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

name
string

Name of the Service Request.

description
string

Description of the entity

object

Tags

yaml
string

YAML for the Service Request

Responses
400

Bad Request

500

Internal Server Error

default

Returns the created Service

post/ng/api/servicesV2
Request samples
{
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "name": "string",
  • "description": "string",
  • "tags": {
    },
  • "yaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Create Services

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

Details of the Services to be created

Array
identifier
string

Identifier of the Service Request.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

name
string

Name of the Service Request.

description
string

Description of the entity

object

Tags

yaml
string

YAML for the Service Request

Responses
400

Bad Request

500

Internal Server Error

default

Returns the created Services

post/ng/api/servicesV2/batch
Request samples
[
  • {
    }
]
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete a Service by identifier

SecurityApiKey
Request
path Parameters
serviceIdentifier
required
string

Service Identifier for the entity

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

header Parameters
If-Match
string
Responses
400

Bad Request

500

Internal Server Error

default

Returns true if the Service is deleted

delete/ng/api/servicesV2/{serviceIdentifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets a Service by identifier

SecurityApiKey
Request
path Parameters
serviceIdentifier
required
string

Service Identifier for the entity

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

deleted
boolean
Default: false

Specify whether Service is deleted or not

Responses
400

Bad Request

500

Internal Server Error

default

The saved Service

get/ng/api/servicesV2/{serviceIdentifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Service Access list

SecurityApiKey
Request
query Parameters
page
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

size
integer <int32>
Default: 100

Results per page

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

searchTerm
string

The word to be searched and included in the list response

serviceIdentifiers
Array of strings

List of ServicesIds

sort
Array of strings

Specifies the sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order

type
string
Enum: "Kubernetes" "NativeHelm" "Ssh" "WinRm" "ServerlessAwsLambda" "AzureWebApp" "CustomDeployment" "ECS"
gitOpsEnabled
boolean
Responses
400

Bad Request

500

Internal Server Error

default

Returns the list of Services for a Project that are accessible

get/ng/api/servicesV2/list/access
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Service list

SecurityApiKey
Request
query Parameters
page
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

size
integer <int32>
Default: 100

Results per page

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

searchTerm
string

The word to be searched and included in the list response

serviceIdentifiers
Array of strings

List of ServicesIds

sort
Array of strings

Specifies the sorting criteria of the list. Like sorting based on the last updated entity, alphabetical sorting in an ascending or descending order

type
string
Enum: "Kubernetes" "NativeHelm" "Ssh" "WinRm" "ServerlessAwsLambda" "AzureWebApp" "CustomDeployment" "ECS"
gitOpsEnabled
boolean
deploymentTemplateIdentifier
string
versionLabel
string
Responses
400

Bad Request

500

Internal Server Error

default

Returns the list of Services for a Project

get/ng/api/servicesV2
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update a Service by identifier

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

header Parameters
If-Match
string
Request Body schema:

Details of the Service to be updated

identifier
string

Identifier of the Service Request.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

name
string

Name of the Service Request.

description
string

Description of the entity

object

Tags

yaml
string

YAML for the Service Request

Responses
400

Bad Request

500

Internal Server Error

default

Returns the updated Service

put/ng/api/servicesV2
Request samples
{
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "name": "string",
  • "description": "string",
  • "tags": {
    },
  • "yaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Upsert a Service by identifier

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

header Parameters
If-Match
string
Request Body schema:

Details of the Service to be updated

identifier
string

Identifier of the Service Request.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

name
string

Name of the Service Request.

description
string

Description of the entity

object

Tags

yaml
string

YAML for the Service Request

Responses
400

Bad Request

500

Internal Server Error

default

Returns the updated Service

put/ng/api/servicesV2/upsert
Request samples
{
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "name": "string",
  • "description": "string",
  • "tags": {
    },
  • "yaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}