services

Upsert a service by identifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
string
header Parameters
If-Match
string
Request Body schema:
identifier
string
orgIdentifier
string
projectIdentifier
string
name
string
description
string
object
version
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/ng/api/services/upsert
Request samples
{
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "name": "string",
  • "description": "string",
  • "tags": {
    },
  • "version": 0
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets Service list for a project

Request
Security:
ApiKey (readwrite)
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 100
accountId
string
orgIdentifier
string
projectIdentifier
string
serviceIdentifiers
Array of strings
sort
Array of strings
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/services
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/services?page=0&size=100&accountId=string&orgIdentifier=string&projectIdentifier=string&serviceIdentifiers=string&sort=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Update a service by identifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
string
header Parameters
If-Match
string
Request Body schema:
identifier
string
orgIdentifier
string
projectIdentifier
string
name
string
description
string
object
version
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/ng/api/services
Request samples
{
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "name": "string",
  • "description": "string",
  • "tags": {
    },
  • "version": 0
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Create a Service

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
string
Request Body schema:
identifier
string
orgIdentifier
string
projectIdentifier
string
name
string
description
string
object
version
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/ng/api/services
Request samples
{
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "name": "string",
  • "description": "string",
  • "tags": {
    },
  • "version": 0
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Create Services

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
string
Request Body schema:
Array
identifier
string
orgIdentifier
string
projectIdentifier
string
name
string
description
string
object
version
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/ng/api/services/batch
Request samples
[
  • {
    }
]
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets a Service by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
serviceIdentifier
required
string
query Parameters
accountId
string
orgIdentifier
string
projectIdentifier
string
deleted
boolean
Default: false
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/services/{serviceIdentifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/services/:serviceIdentifier?accountId=string&orgIdentifier=string&projectIdentifier=string&deleted=false' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Delete a service by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
serviceIdentifier
required
string
query Parameters
accountId
string
orgIdentifier
string
projectIdentifier
string
header Parameters
If-Match
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

delete/ng/api/services/{serviceIdentifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/ng/api/services/:serviceIdentifier?accountId=string&orgIdentifier=string&projectIdentifier=string' \
  -H 'If-Match: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}