Licenses

This contains APIs related to licenses as defined in Harness

Extends Trial License For A Module

SecurityApiKey
Request
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

Specifies the module type.

Enum: "CD" "CI" "CV" "CF" "CE" "STO" "CORE" "PMS" "TEMPLATESERVICE" "GOVERNANCE" "CHAOS"
edition
required
string

Specifies the type of the edition.

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

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

moduleType
required
string

A Harness Platform module.

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

Bad Request

500

Internal server error

default

Returns all actions under each edition

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

Get Last Modified Time Under Each ModuleType

SecurityApiKey
Request
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
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets All Module License Information in Account

SecurityApiKey
Request
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
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Module License

SecurityApiKey
Request
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
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Module Licenses By Account And ModuleType

SecurityApiKey
Request
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" "STO" "CORE" "PMS" "TEMPLATESERVICE" "GOVERNANCE" "CHAOS"
Responses
400

Bad Request

500

Internal server error

default

Returns all of a module's licenses

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

Gets Module Licenses With Summary By Account And ModuleType

SecurityApiKey
Request
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" "STO" "CORE" "PMS" "TEMPLATESERVICE" "GOVERNANCE" "CHAOS"
Responses
400

Bad Request

500

Internal server error

default

Returns a module's license summary

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

Starts Free License For A Module

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

moduleType
required
string

A Harness Platform module.

Enum: "CD" "CI" "CV" "CF" "CE" "STO" "CORE" "PMS" "TEMPLATESERVICE" "GOVERNANCE" "CHAOS"
referer
required
string

Referer URL

Responses
400

Bad Request

500

Internal server error

default

Returns the Free License of the specified Module.

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

Starts Trial License For A Module

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

referer
string

Referrer URL

Request Body schema: application/json

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

moduleType
required
string

Specifies the module type.

Enum: "CD" "CI" "CV" "CF" "CE" "STO" "CORE" "PMS" "TEMPLATESERVICE" "GOVERNANCE" "CHAOS"
edition
required
string

Specifies the type of the edition.

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": [
    ]
}