runScanner
    • PDF

    runScanner

    • PDF

    Article summary

    Available in VPC

    Runs a specific scanner in the user’s catalog.

    Requests

    Request URL

    PUT {DATA_CATALOG API_URL}/catalogs/{catalog-id}/scanners/{scanner-id}/run-scanner
    

    Request parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    catalogIdYesStringUnique catalog ID
    (ref: getCatalogs)
    scannerIdYesStringUnique scanner ID

    Request header

    See common guide.

    Request examples

    curl -X PUT "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/scanners/{scanner-id}/run-scanner" \
        -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
        -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"  \
        -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
    

    Responses

    Response bodies

    ItemTypeDescription
    scannerIdintUnique scanner ID
    nameStringScanner name
    statusStringScanner status (pending for run/run start/running/run end)

    Response examples

    HTTP

    HTTP StatusDescription
    200OK

    JSON

    {
      "scannerId": 89,
      "name": "datacatalog-test-scanner",
      "status": "SCANNER_STARTING",
    }
    

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.