Get a package
Server:
https://{kibana_url}
- GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
- GET /api/fleet/epm/packages/{pkgName}
- GET /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}
Refer to Spaces for more information.
Get information about a specific version of a package.
Path Parameters
-
pkgNamestringrequired -
Package name
-
pkgVersionstringoptional -
Package version
Leave it out to use
/api/fleet/epm/packages/{pkgName}.
Query Parameters
-
ignoreUnverifiedboolean When true, returns the package even if the signature cannot be verified
-
prereleaseboolean When true, include prerelease versions
-
fullboolean When true, return the full package info including assets
-
withMetadataboolean · default: false When true, include package metadata such as whether it has package policies
Responses
Successful response
-
itemrequired -
agentobject -
privilegesobject -
rootboolean -
assetsmap string to objectrequired -
categoriesstring · max: 100 -
conditionsobject -
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
elasticobject -
capabilitiesstring · max: 10 -
subscriptionstring -
data_streamsstring to object · max: 1000 -
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
descriptionstring -
discoveryobject -
downloadstring -
elasticsearchmap string to object -
format_versionstring -
iconsobject · max: 100 -
installationInfo -
additional_spaces_installed_kibanamap string to object -
created_atstring -
experimental_data_stream_featuresobject · max: 100 -
data_streamstring · max: 1024required -
featuresobjectrequired -
doc_value_only_numericboolean -
doc_value_only_otherboolean -
synthetic_sourceboolean -
tsdbboolean -
install_sourcerequired -
Values:
registryuploadbundledcustom -
install_statusrequired -
Values:
installedinstallinginstall_failed -
installed_esobject · max: 10000required -
customDataStreamOriginTypestring -
deferredboolean -
idstringrequired -
typerequired -
Values:
indexindex_templatecomponent_templateingest_pipelineilm_policydata_stream_ilm_policytransformml_modelknowledge_baseesql_view -
versionstring -
installed_kibanaobject · max: 10000required -
installed_kibana_space_idstring -
is_rollback_ttl_expiredboolean -
latest_executed_stateobject -
errorstring -
namestring -
started_atstring -
latest_install_failed_attemptsobject · max: 10 -
created_atstringrequired -
target_versionstringrequired -
namestringrequired -
namespacesstring · max: 100 -
previous_versionstringnullable -
rolled_backboolean -
typestringrequired -
updated_atstring -
verification_key_idstringnullable -
verification_statusrequired -
Values:
unverifiedverifiedunknown -
versionstringrequired -
internalboolean -
keepPoliciesUpToDateboolean -
latestVersionstring -
licensestring -
licensePathstring -
namestringrequired -
noticestring -
pathstring -
policy_templatesstring to object · max: 1000 -
readmestring -
release -
Values:
gabetaexperimental -
screenshotsobject · max: 100 -
signature_pathstring -
statusstring -
titlestringrequired -
typeenum | string -
Values:
integrationinputcontent -
var_groupsobject · max: 100 -
descriptionstring -
namestringrequired -
optionsobject · max: 100required -
descriptionstring -
hide_in_deployment_modes· max: 2 -
Values:
defaultagentless -
namestringrequired -
titlestringrequired -
varsstring · max: 100required -
selector_titlestringrequired -
titlestringrequired -
varsstring to object · max: 1000 -
versionstringrequired -
metadata -
has_policiesbooleanrequired
Bad Request
-
attributesobjectrequired -
errorstring -
errorTypestring -
messagestringrequired -
statusCodenumber