yaml-schema

Get Yaml Schema

Request
Security:
ApiKey (readwrite)
query Parameters
entityType
required
string
Enum: "Projects" "Pipelines" "PipelineSteps" "Connectors" "Secrets" "Service" "Environment" "InputSets" "CvConfig" "Delegates" "DelegateConfigurations" "CvVerificationJob" "IntegrationStage" "IntegrationSteps" "CvKubernetesActivitySource" "DeploymentSteps" "DeploymentStage" "ApprovalStage" "FeatureFlagStage" "Template" "Triggers" "MonitoredService" "GitRepositories"
subtype
string
Enum: "K8sCluster" "Git" "Splunk" "AppDynamics" "Prometheus" "Dynatrace" "Vault" "AzureKeyVault" "DockerRegistry" "Local" "AwsKms" "GcpKms" "AwsSecretManager" "Gcp" "Aws" "Artifactory" "Jira" "Nexus" "Github" "Gitlab" "Bitbucket" "Codecommit" "CEAws" "CEAzure" "GcpCloudCost" "CEK8sCluster" "HttpHelmRepo" "NewRelic" "Datadog" "SumoLogic" "PagerDuty"
projectIdentifier
string
orgIdentifier
string
scope
string
Enum: "account" "org" "project" "unknown"
identifier
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/yaml-schema
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/yaml-schema?entityType=Projects&subtype=K8sCluster&projectIdentifier=string&orgIdentifier=string&scope=account&identifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get Yaml Schema

Request
Security:
ApiKey (readwrite)
query Parameters
entityType
required
string
Enum: "Projects" "Pipelines" "PipelineSteps" "Connectors" "Secrets" "Service" "Environment" "InputSets" "CvConfig" "Delegates" "DelegateConfigurations" "CvVerificationJob" "IntegrationStage" "IntegrationSteps" "CvKubernetesActivitySource" "DeploymentSteps" "DeploymentStage" "ApprovalStage" "FeatureFlagStage" "Template" "Triggers" "MonitoredService" "GitRepositories"
projectIdentifier
string
orgIdentifier
string
scope
string
Enum: "account" "org" "project" "unknown"
identifier
string
accountIdentifier
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/yaml-schema
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/yaml-schema?entityType=Projects&projectIdentifier=string&orgIdentifier=string&scope=account&identifier=string&accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Invalidate yaml schema cache

Request
Security:
ApiKey (readwrite)
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/pipeline/api/yaml-schema/invalidate-cache
Request samples
curl -i -X POST \
  https://app.harness.io/gateway/pipeline/api/yaml-schema/invalidate-cache \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}