Harness

SMTP

This contains APIs related to SmtpConfig as defined in Harness

Delete Smtp Config by identifier

Securityx-api-key
Request
path Parameters
identifier
required
string

Config identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Boolean status whether request was successful or not

delete/ng/api/smtpConfig/{identifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets Smtp config by accountId
Securityx-api-key 
Request 
query Parameters
accountId
string
Account Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal server error


default
returns the SmtpConfig having accountId as specified in request


get/ng/api/smtpConfig
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Updates the Smtp Config
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Request Body schema: application/json
required
uuid
string
Identifier of the SMTP config.


 
accountId
required
string
Account Identifier for the Entity.


 
name
required
string
Name of the SMTP config.


 
required
object (SmtpConfig) 
This has the SMTP configuration details defined in Harness.


 
Responses 
400
Bad Request


500
Internal server error


default
Returns updated config


put/ng/api/smtpConfig
Request samples 
application/json
{
  • "uuid": "string",
  • "accountId": "string",
  • "name": "string",
  • "value": {
    }
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Creates SMTP config
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Request Body schema: application/json
required
uuid
string
Identifier of the SMTP config.


 
accountId
required
string
Account Identifier for the Entity.


 
name
required
string
Name of the SMTP config.


 
required
object (SmtpConfig) 
This has the SMTP configuration details defined in Harness.


 
Responses 
400
Bad Request


500
Internal server error


default
Returns created config


post/ng/api/smtpConfig
Request samples 
application/json
{
  • "uuid": "string",
  • "accountId": "string",
  • "name": "string",
  • "value": {
    }
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Tests the config's connectivity by sending a test email
Securityx-api-key 
Request 
query Parameters
identifier
required
string
Attribute uuid


 
accountId
required
string
Account Identifier for the Entity.


 
to
required
string
 
subject
required
string
 
body
required
string
 
Responses 
400
Bad Request


500
Internal server error


default
Returns validation Result


post/ng/api/smtpConfig/validate-connectivity
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Checks whether other connectors exist with the same name
Securityx-api-key 
Request 
query Parameters
name
string
The name of Config


 
accountId
required
string
Account Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal server error


default
Returns validation Result


post/ng/api/smtpConfig/validateName
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to Token