Scan Resource Service Create

Scan Resource Service Create

Create a Scan.

Request
URI
POST
https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/clusters/{scan.fullName.clusterName}/inspection/scans
COPY
Path Parameters
string
scan.fullName.clusterName
Required

Name of Cluster.


Request Body
{
    "scan": {
        "type": {
            "kind": "string",
            "version": "string",
            "package": "string"
        },
        "meta": {
            "uid": "string",
            "generation": "string",
            "resourceVersion": "string",
            "creationTime": "string",
            "updateTime": "string",
            "description": "string",
            "parentReferences": [
                {
                    "rid": "string",
                    "uid": "string"
                }
            ]
        },
        "fullName": {
            "orgId": "string",
            "managementClusterName": "string",
            "provisionerName": "string",
            "clusterName": "string",
            "name": "string"
        },
        "spec": {
            "cisSpec": {
                "cisTargets": [
                    "string"
                ]
            }
        },
        "status": {
            "report": {
                "info": {
                    "reportId": "string",
                    "runDatetime": "string",
                    "scanType": "string",
                    "numInspections": "string",
                    "numFailed": "string",
                    "result": "string",
                    "numWarning": "string",
                    "progressInfo": {
                        "totalNumTests": "string",
                        "numTestsCompleted": "string"
                    },
                    "kubeServerVersion": "string"
                },
                "tarballDownloadUrl": "string"
            },
            "phase": "string",
            "phaseInfo": "string",
            "availablePhases": [
                "string"
            ]
        }
    }
}
Responses
200

A successful response.

{
    "scan": {
        "type": {
            "kind": "string",
            "version": "string",
            "package": "string"
        },
        "meta": {
            "uid": "string",
            "generation": "string",
            "resourceVersion": "string",
            "creationTime": "string",
            "updateTime": "string",
            "description": "string",
            "parentReferences": [
                {
                    "rid": "string",
                    "uid": "string"
                }
            ]
        },
        "fullName": {
            "orgId": "string",
            "managementClusterName": "string",
            "provisionerName": "string",
            "clusterName": "string",
            "name": "string"
        },
        "spec": {
            "cisSpec": {
                "cisTargets": [
                    "string"
                ]
            }
        },
        "status": {
            "report": {
                "info": {
                    "reportId": "string",
                    "runDatetime": "string",
                    "scanType": "string",
                    "numInspections": "string",
                    "numFailed": "string",
                    "result": "string",
                    "numWarning": "string",
                    "progressInfo": {
                        "totalNumTests": "string",
                        "numTestsCompleted": "string"
                    },
                    "kubeServerVersion": "string"
                },
                "tarballDownloadUrl": "string"
            },
            "phase": "string",
            "phaseInfo": "string",
            "availablePhases": [
                "string"
            ]
        }
    }
}

default

An unexpected error response.

Returns grpc.gateway.runtime.Error of type(s) */*
{
    "error": "string",
    "code": 0,
    "message": "string",
    "details": [
        {
            "typeUrl": "string",
            "value": "string"
        }
    ]
}