Skip to content
Mengi Cloud Mengi Cloud Docs

Analyze Docker Image Endpoint

POST
/analysis/docker-image
 
curl --request POST \
  --url https://api.mengi.cloud/analysis/docker-image \
  --header 'Content-Type: application/json' \
  --data '{ "image_reference": "example" }'

Analyze a Docker image reference to extract:

  • Image information
  • Suggested ports and volumes
  • Required environment variables
  • Backing services (databases, caches, etc.)
  • 12-factor app compliance analysis
  • Deployment recommendations

Request Body required

Section titled “Request Body required ”
Media type application/json
DockerImageAnalysisRequest
object
image_reference
required
Image Reference
string
Example generated
{
  "image_reference": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
DockerImageAnalysisResponse
object
analysis
required
DockerImageAnalysis
object
image_info
Any of:
ImageInfo
object
reference
required
Reference
string
is_official
Is Official
boolean
description
Any of:
string
ports
Ports
Array<object>
default:
PortInfo
object
port
required
Port
integer
protocol
Protocol
string
default: tcp
description
Any of:
string
volumes
Volumes
Array<object>
default:
VolumeInfo
object
path
required
Path
string
purpose
Any of:
string
required
Required
boolean
environment_variables
Environment Variables
Array<object>
default:
EnvVarInfo
object
name
required
Name
string
required
Required
boolean
description
Any of:
string
backing_services
Backing Services
Array<object>
default:
BackingServiceInfo
object
type
required
Type
string
detected_from
Any of:
string
twelve_factor
Any of:
TwelveFactorAnalysis
object
compliant
Any of:
boolean
score
Any of:
integer
findings
Findings
Array<object>
default:
TwelveFactorFinding
object
factor
required
Factor
string
status
required
Status
string
note
Any of:
string
healthcheck
Any of:
HealthcheckInfo
object
endpoint
Any of:
string
suggested
Suggested
boolean
suggestions
Suggestions
Array<string>
default:
deployment_recommendations
Any of:
DeploymentRecommendations
object
replicas
Replicas
integer
default: 2
resources
Any of:
ResourceRequirements
object
requests
required
ResourceSpec
object
cpu
required
Cpu
string
memory
required
Memory
string
limits
required
ResourceSpec
object
cpu
required
Cpu
string
memory
required
Memory
string
suggested_services
Suggested Services
Array<object>
default:
SuggestedService
object
id
required
Id
string
name
required
Name
string
type
required
Type
string
detected_from
required
Detected From
string
service_recommendations
Service Recommendations
Array<object>
default:
ServiceRecommendation
object
service_type
required
Service Type
string
service_name
required
Service Name
string
detected_from
required
Detected From
string
helm_chart
required
HelmChartOption
object
name
required
Name
string
repository
required
Repository
string
description
required
Description
string
usage
required
Usage
object
key
additional properties
any
metadata_source
required
Metadata Source
string
Example 
{
  "analysis": {
    "image_info": {
      "is_official": false
    },
    "ports": [],
    "volumes": [],
    "environment_variables": [],
    "backing_services": [],
    "twelve_factor": {
      "findings": []
    },
    "healthcheck": {
      "suggested": false
    },
    "suggestions": [],
    "deployment_recommendations": {
      "replicas": 2
    }
  },
  "suggested_services": [],
  "service_recommendations": []
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}