Licenses

This contains APIs related to licenses as defined in Harness

Gets Module Licenses With Summary By Account And ModuleType

Request
Security:
ApiKey (readwrite)
path Parameters
accountIdentifier
required
string

Account Identifier for the Entity

query Parameters
moduleType
required
string

A Harness Platform module.

Enum: "CD" "CI" "CV" "CF" "CE" "CORE" "PMS" "TEMPLATESERVICE"
Responses
400

Bad Request

500

Internal server error

default

Returns a module's license summary

get/ng/api/licenses/{accountIdentifier}/summary
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/licenses/:accountIdentifier/summary?moduleType=CD' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets All Module License Information in Account

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Responses
400

Bad Request

500

Internal server error

default

Returns all licenses for an account

get/ng/api/licenses/account
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/licenses/account?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Starts Free License For A Module

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

moduleType
required
string

A Harness Platform module.

Enum: "CD" "CI" "CV" "CF" "CE" "CORE" "PMS" "TEMPLATESERVICE"
Responses
400

Bad Request

500

Internal server error

default

Returns the Free License of the specified Module.

post/ng/api/licenses/free
Request samples
curl -i -X POST \
  'https://app.harness.io/gateway/ng/api/licenses/free?accountIdentifier=string&moduleType=CD' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Starts Trial License For A Module

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Request Body schema: application/json

This is the details of the Trial License. ModuleType and edition are mandatory

moduleType
required
string
Enum: "CD" "CI" "CV" "CF" "CE" "CORE" "PMS" "TEMPLATESERVICE"
edition
required
string
Enum: "COMMUNITY" "FREE" "TEAM" "ENTERPRISE"
Responses
400

Bad Request

500

Internal server error

default

Returns the Trial License of the specified Module.

post/ng/api/licenses/trial
Request samples
application/json
{
  • "moduleType": "CD",
  • "edition": "COMMUNITY"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Module Licenses By Account And ModuleType

Request
Security:
ApiKey (readwrite)
path Parameters
accountIdentifier
required
string

Account Identifier for the Entity

query Parameters
moduleType
required
string

A Harness Platform module.

Enum: "CD" "CI" "CV" "CF" "CE" "CORE" "PMS" "TEMPLATESERVICE"
Responses
400

Bad Request

500

Internal server error

default

Returns all of a module's licenses

get/ng/api/licenses/modules/{accountIdentifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/licenses/modules/:accountIdentifier?moduleType=CD' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Extends Trial License For A Module

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Request Body schema: application/json

This is the details of the Trial License. ModuleType and edition are mandatory

moduleType
required
string
Enum: "CD" "CI" "CV" "CF" "CE" "CORE" "PMS" "TEMPLATESERVICE"
edition
required
string
Enum: "COMMUNITY" "FREE" "TEAM" "ENTERPRISE"
Responses
400

Bad Request

500

Internal server error

default

Returns the Trial License of the specified Module.

post/ng/api/licenses/extend-trial
Request samples
application/json
{
  • "moduleType": "CD",
  • "edition": "COMMUNITY"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get Allowed Actions Under Each Edition

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

moduleType
required
string

A Harness Platform module.

Enum: "CD" "CI" "CV" "CF" "CE" "CORE" "PMS" "TEMPLATESERVICE"
Responses
400

Bad Request

500

Internal server error

default

Returns all actions under each edition

get/ng/api/licenses/actions
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/licenses/actions?accountIdentifier=string&moduleType=CD' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get Last Modified Time Under Each ModuleType

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Responses
400

Bad Request

500

Internal server error

default

Returns last modified time under each module type

post/ng/api/licenses/versions
Request samples
curl -i -X POST \
  'https://app.harness.io/gateway/ng/api/licenses/versions?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Module License

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string

The module license identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Responses
400

Bad Request

500

Internal server error

default

Returns a module's license

get/ng/api/licenses/{identifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/licenses/:identifier?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}