How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harness Services API

This contains APIs related to Services

Harness Services API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 17 operations across 14 paths, and defines 144 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

17 operations 14 paths 144 schemas 1 DELETE7 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Services API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 1 DELETE, 7 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Services 17

This contains APIs related to Services

POST
/ng/api/servicesV2/check-allowed-values
Check for allowed-values in the Services
checkAllowedValuesInServices 1 param → 400500default
GET
/ng/api/servicesV2
Gets Service list
getServiceList 15 params → 400500default
PUT
/ng/api/servicesV2
Update a Service by identifier
updateServiceV2 14 params body → 400500default
POST
/ng/api/servicesV2
Create a Service
createServiceV2 1 param body → 400500default
POST
/ng/api/servicesV2/batch
Create Services
createServicesV2 1 param body → 400500default
POST
/ng/api/servicesV2/batch/partial
Create Services with partial success support - returns both successful and…
createServicesPartialBatch 1 param body → 400500default
GET
/ng/api/servicesV2/{serviceIdentifier}
Gets a Service by identifier
getServiceV2 5 params → 400500default
DELETE
/ng/api/servicesV2/{serviceIdentifier}
Delete a Service by identifier
deleteServiceV2 6 params → 400500default
GET
/ng/api/servicesV2/k8s/command-flags
Retrieving the list of Kubernetes Command Options
k8sCmdFlags 2 params → 400500default
GET
/ng/api/servicesV2/kustomize/command-flags
Retrieving the list of Kustomize Command Flags
kustomizeCmdFlags → 400500default
GET
/ng/api/servicesV2/plugin-info
Get Plugin Info at Service
getPluginInfo → 400500default
GET
/ng/api/servicesV2/hooks/actions
Retrieving the list of actions available for service hooks
hookActions 1 param → 400500default
POST
/ng/api/servicesV2/import
Get Service YAML from Git Repository
importService 10 params → 400500default
GET
/ng/api/servicesV2/list/access
Gets Service Access list
getServiceAccessList 14 params → 400500default
POST
/ng/api/servicesV2/move-config/{serviceIdentifier}
Move Service YAML from inline to remote
moveServiceConfigs 13 params → 400500default
PUT
/ng/api/servicesV2/{serviceIdentifier}/update-git-metadata
Update git-metadata in remote service Entity
updateServiceGitDetails 7 params → 400500default
PUT
/ng/api/servicesV2/upsert
Upsert a Service by identifier
upsertServiceV2 2 params body → 400500default

Schemas 144

The contract defines 144 schemas that model the data the API accepts and returns. The most detailed are FileOptions (44 properties), FileOptionsOrBuilder (40 properties), FileDescriptorProto (38 properties), CvDescriptorProto (36 properties). Each schema is shown below with its type and property counts.

ResponseDTOServiceImportResponse
object
4 properties
GovernanceMetadata2
object
GovernanceMetadata for OPA evaluation
33 properties
ParserMessageLite
object
UninterpretedOption
object
20 properties
ResponseDTOServiceResponse
object
4 properties
ResponseDTOPluginInfoResponseDto
object
4 properties
GitDetails2
object
3 properties
FieldDescriptor
object
26 properties
ParserLocation
object
PluginInfoResponseDto
object
2 properties
FieldOptionsOrBuilder
object
27 properties
EnumValueDescriptorProtoOrBuilder
object
11 properties
PolicySetMetadataOrBuilder
object
27 properties
ParserEnumValueDescriptorProto
object
Error1
object
This is Error entity as defined in Harness
7 properties
DescriptorProtoOrBuilder
object
31 properties
ParserFieldDescriptorProto
object
CvDescriptorProto
object
36 properties
Location
object
19 properties
FeatureSupport
object
14 properties
ParserPolicyMetadata
object
ParserFeatureSupport
object
ExtensionRangeOrBuilder
object
10 properties
EntityListWithAllowedValuesResponse
object
This is the list of entities which are using the allowedValues
6 properties
MessageOptionsOrBuilder
object
16 properties
TemplateDescriptorProtoOrBuilder
object
32 properties
OneofOptionsOrBuilder
object
11 properties
FieldDescriptorProtoOrBuilder
object
23 properties
ReservedRangeOrBuilder
object
8 properties
CvDescriptor
object
14 properties
ExtensionRange
object
13 properties
ParserFileDescriptorProto
object
ResponseDTOServiceGitUpdateResponse
object
4 properties
FileOptions
object
44 properties
CvPolicyMetadata
object
31 properties
OneofDescriptor
object
9 properties
ParserPolicySetMetadata
object
NamePart
object
12 properties
ParserReservedRange
object
ParserEnumOptions
object
ResponseDTOSetKustomizeCommandFlagType
object
4 properties
ParserEditionDefault
object
ServiceOptionsOrBuilder
object
12 properties
ServiceDescriptorProto
object
16 properties
PageResponseServiceResponse
object
8 properties
ParserMethodDescriptorProto
object
ParserOneofDescriptorProto
object
ParserMessageOptions
object
ServiceGitUpdateResponse
object
Contains info about service that is updated.
1 property
DeclarationOrBuilder
object
13 properties
ServiceOptions
object
16 properties
UninterpretedOptionOrBuilder
object
17 properties
OneofOptions
object
15 properties
ServiceDescriptor
object
7 properties
ServiceMoveConfigResponse
object
Tells us if the service move config operation was successful or not
ParserExtensionRange
object
ParserUninterpretedOption
object
ParserFieldOptions
object
ResponseMessage
object
7 properties
ResponseDTOServiceBatchResponse
object
4 properties
FeatureSetOrBuilder
object
12 properties
ParserServiceOptions
object
Descriptor
object
14 properties
MethodDescriptor
object
11 properties
ParserOneofOptions
object
SourceCodeInfo
object
13 properties
ResponseDTOSetServiceHookAction
object
4 properties
LocationOrBuilder
object
16 properties
FieldDescriptorProto
object
26 properties
OneofDescriptorProto
object
13 properties
ParserDescriptorProto
object
EditionDefaultOrBuilder
object
9 properties
EnumReservedRangeOrBuilder
object
8 properties
FileDescriptorProto
object
38 properties
ParserMethodOptions
object
ParserExtensionRangeOptions
object
ParserServiceDescriptorProto
object
ResponseDTOServiceMoveConfigResponse
object
4 properties
ServiceDescriptorProtoOrBuilder
object
13 properties
ParserFeatureSet
object
Message
object
8 properties
MethodDescriptorProtoOrBuilder
object
16 properties
ByteString
object
2 properties
ParserMessage
object
ResponseDTOBoolean
object
4 properties
EnumOptionsOrBuilder
object
14 properties
EnumDescriptorProto
object
21 properties
ParserSourceCodeInfo
object
MethodOptionsOrBuilder
object
13 properties
ResponseDTOAllowedValuesUsagesInternalDTO
object
4 properties
PolicyMetadata1
object
31 properties
EnumValueDescriptorProto
object
14 properties
ParserEnumValueOptions
object
ParserEnumDescriptorProto
object
UnknownFieldSet
object
6 properties
EnumValueOptions
object
19 properties
MethodDescriptorProto
object
19 properties
TemplateDescriptorProto
object
36 properties
AllowedValuesUsagesInternalDTO
object
This is the list of all entries in one kind of entity which are using the allowedValues
2 properties
ServiceImportResponse
object
Contains the details of the Saved Service
2 properties
FeatureSet
object
16 properties
EnumValueDescriptor
object
8 properties
PolicySetMetadata1
object
30 properties
ExtensionRangeOptions
object
19 properties
ParserDeclaration
object
ParserGovernanceMetadata
object
EnumDescriptorProtoOrBuilder
object
18 properties
FeatureSupportOrBuilder
object
11 properties
OpaOnSaveStatus
object
OPA onSave governance status for a remote CD entity; present when evaluated
9 properties
EnumOptions
object
18 properties
EnumValueOptionsOrBuilder
object
15 properties
EditionDefault
object
12 properties
FileDescriptor
object
12 properties
ValidationError
object
2 properties
OneofDescriptorProtoOrBuilder
object
10 properties
MessageOptions
object
20 properties
FileOptionsOrBuilder
object
40 properties
ParserFileOptions
object
ServiceBatchResponse
object
Batch service creation response with partial success support
5 properties
ParserEnumReservedRange
object
ParserNamePart
object
NamePartOrBuilder
object
9 properties
CvDeclaration
object
16 properties
ResourceItem
object
2 properties
ExtensionRangeOptionsOrBuilder
object
15 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
MethodOptions
object
17 properties
MessageLite
object
4 properties
FieldOptions
object
31 properties
EnumReservedRange
object
11 properties
ResponseDTOPageResponseServiceResponse
object
4 properties
ReservedRange
object
11 properties
ServiceResponse1
object
6 properties
EnumDescriptor
object
9 properties
ResponseDTOSetK8sCommandFlagType
object
4 properties
ServiceResponseDetails
object
This is the Service entity defined in Harness
11 properties
ErrorMetadata2
object
This implements different error meta data objects
1 property
SourceCodeInfoOrBuilder
object
9 properties
ResponseDTOListServiceResponse
object
4 properties
Parser
object
PolicyMetadataOrBuilder
object
28 properties
ServiceFailureResponse
object
Failed service creation/update details with complete scope information
9 properties 4 required
EntityGitDetails1
object
This contains Validity Details of the Entity
2 properties
ServiceRequest
object
Service Request details defined in Harness.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-services-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Services API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.