---
title: "Export galaxy clusters"
method: POST
path: "/galaxies/export/{galaxyId}"
tags: ["Galaxies"]
---

# Export galaxy clusters

`POST /galaxies/export/{galaxyId}`

## Path parameters

- `galaxyId` union, required
  - string
  - string, uuid

## Request body

- object
  - `Galaxy` object
    - `default` boolean — Include default galaxy clusters (`GalaxyCluster.default = true`). This flag is additive with `custom`. If both are true, both default and custom clusters are included. If neither is true, no clusters are returned.
    - `custom` boolean — Include custom galaxy clusters (`GalaxyCluster.default = false`). This flag is additive with `default`. If both are true, both default and custom clusters are included. If neither is true, no clusters are returned.
    - `distribution` union — Filter galaxy clusters by exact distribution level. May be provided as a single distribution ID or as a list of IDs. When a list is provided, clusters matching any of the given distribution levels are returned. This parameter is an exact metadata filter and does not perform access control.
      - '0' | '1' | '2' | '3' | '4' | '5' — Who will be able to see this event once it becomes published and eventually when it becomes pulled: * `0` - Your organization only * `1` - This community only * `2` - Connected communities * `3` - All communities * `4` - Sharing group * `5` - Inherit Event
      - DistributionLevelId[]
    - `format` 'default' | 'misp-galaxy' — Output format of the export. If set to `misp-galaxy`, the result set is returned in the canonical misp-galaxy format.
    - `download` boolean — If true, return the response as a downloadable JSON attachment. If false, return the response body inline.

## Response `200`

Export galaxy clusters response

- union
  - GalaxyCluster[]
    - `id` string
    - `uuid` string, uuid
    - `collection_uuid` string, uuid
    - `type` string
    - `value` string
    - `tag_name` string
    - `description` string
    - `galaxy_id` string
    - `source` string
    - `authors` string[]
    - `version` string, nullable
    - `distribution` '0' | '1' | '2' | '3' | '4' | '5' — Who will be able to see this event once it becomes published and eventually when it becomes pulled: * `0` - Your organization only * `1` - This community only * `2` - Connected communities * `3` - All communities * `4` - Sharing group * `5` - Inherit Event
    - `sharing_group_id` union
      - string, nullable
      - string, uuid, nullable
    - `org_id` string
    - `orgc_id` string
    - `default` boolean
    - `locked` boolean
    - `extends_uuid` string, nullable
    - `extends_version` string, nullable
    - `published` boolean
    - `deleted` boolean
    - `GalaxyElement` GalaxyElement[]
      - `id` string
      - `galaxy_cluster_id` string
      - `key` string
      - `value` string
  - GalaxyMispFormat — Galaxy and clusters representation in misp-galaxy format.
    - `name` string
    - `type` string
    - `authors` string[]
    - `version` union
      - boolean
      - string, nullable
    - `uuid` string, uuid
    - `source` string
    - `values` object[]
      - `description` string
      - `uuid` string, uuid
      - `value` string
      - `extends_uuid` string, nullable
      - `extends_Version` string, nullable
      - `meta` object — Each Galaxy element associated to this cluster represents a key-value property.

## Other responses

- `403` — Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.
- `404` — The specified resource was not found
- `default` — Unexpected API error

---

[API](https://skmtc.net/misp/apis/misp-automation-api.md) · [All operations](https://skmtc.net/misp/apis/misp-automation-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/misp/misp-automation-api/revisions/88b34ff032a1/schema)
