Jump to

• Request
• Response

Delete the target with the given id

delete

https://EM_HOST:8080/em/api/targets/{targetId}

This api deletes the target with the given id. If an access point is given, then only that access point is deleted. If the target is an agent target, then also the monitored targets can be deleted. In case of a composite target the member targets can get deleted too.

Request

Path Parameters

• targetId(required): string
  the target id

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Payload to delete a target

Show Source

• accessPoint: accessPoint
• deleteMonitoredTargets: boolean
  Indicates if monitored targets of a host target should get deleted along with the host target.

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to delete a target",
    "type":"object",
    "properties":{
        "accessPoint":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/NameTypePair"
                },
                {
                    "description":"If only an access point is to be deleted this defines its name and type."
                },
                {
                    "example":{
                        "name":"MyAccessPointName",
                        "type":"MyAccessPointType"
                    }
                }
            ]
        },
        "deleteMonitoredTargets":{
            "type":"boolean",
            "description":"Indicates if monitored targets of a host target should get deleted along with the host target."
        }
    }
}

Nested Schema : accessPoint

Match All

Show Source

• object NameTypePair
  A pair of name and type.
• If only an access point is to be deleted this defines its name and type.
• Example: { "name":"MyAccessPointName", "type":"MyAccessPointType" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/NameTypePair"
        },
        {
            "description":"If only an access point is to be deleted this defines its name and type."
        },
        {
            "example":{
                "name":"MyAccessPointName",
                "type":"MyAccessPointType"
            }
        }
    ]
}

Nested Schema : NameTypePair

Type: object

A pair of name and type.

Show Source

• name: string
  the name
• type: string
  the type

{
    "x-em-sdk-level":"emSDK",
    "description":"A pair of name and type.",
    "type":"object",
    "properties":{
        "name":{
            "description":"the name",
            "type":"string"
        },
        "type":{
            "description":"the type",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

OK, target got deleted

400 Response

in the case of a processing error like unsupported property given etc.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

target not found or not authorized

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top