Skip to content

Galaxies

delete_galaxy async 

delete_galaxy(auth: Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))], db: Annotated[Session, Depends(get_db)], galaxy_id: Annotated[str, Path(alias=galaxyId)], request: Request) -> DeleteForceUpdateImportGalaxyResponse

“Delete a specific galaxy by its Id.

args:

  • the user’s authentification status

  • the current database

  • the galaxy id

  • the request

returns:

  • the deleted galaxy

delete_galaxy_depr async 

delete_galaxy_depr(auth: Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))], db: Annotated[Session, Depends(get_db)], galaxy_id: Annotated[str, Path(alias=galaxyId)], request: Request) -> DeleteForceUpdateImportGalaxyResponse

Delete Galaxy by GalaxyID.

args:

  • the user’s authentification status

  • the current database

  • the galaxy id

  • the request

returns:

  • the deleted galaxy

get_galaxies async 

get_galaxies(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)]) -> list[GetAllSearchGalaxiesResponse]

Get a list with all existing galaxies.

args:

  • the user’s authentification status

  • the current database

returns:

  • all galaxies

get_galaxy_details async 

get_galaxy_details(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], galaxy_id: Annotated[str, Path(alias=galaxyId)]) -> GetGalaxyResponse

“Gets the details of a galaxy.

args:

  • the user’s authentification status

  • the current database

  • the galaxy id

returns:

  • the details of the galaxy

get_galaxy_details_depr async 

get_galaxy_details_depr(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], galaxy_id: Annotated[str, Path(alias=galaxyId)]) -> GetGalaxyResponse

View Galaxy by given Galaxy ID.

args:

  • the user’s authentification status

  • the current database

  • the galaxy id

returns:

  • the details of the galaxy

search_galaxies async 

search_galaxies(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], body: SearchGalaxiesbyValue) -> list[GetAllSearchGalaxiesResponse]

Search galaxies by search term which matches with galaxy name, namespace, description, kill_chain_order or uuid.”

args:

  • the user’s authentification status

  • the current database

  • the request body

returns:

  • the galaxies found by search

update_galaxy async 

update_galaxy(auth: Annotated[Auth, Depends(authorize(WORKER_KEY, [SITE_ADMIN]))], db: Annotated[Session, Depends(get_db)]) -> DeleteForceUpdateImportGalaxyResponse

Force the galaxies to update with the JSON definitions, not yet implemented.

args:

  • the user’s authentification status

  • the current database

returns:

  • the updated galaxies