SkyPortal (0.9.dev0+git20200117.33ee6b9)

Download OpenAPI specification:Download

SkyPortal API

Authentication

token

Header should be in the format 'token abcd-efgh-0000-1234'

Security Scheme Type	API Key
Header parameter name:	Authorization

Retrieve a comment

path Parameters

created_at required	string <date-time>
source required	string Nullable
origin required	string Nullable
attachment_bytes required	string Nullable
text required	string
ctype required	string <= 14 characters Nullable Enum: "text" "redshift" "classification"
author required	string
attachment_name required	string Nullable
attachment_type required	string Nullable
id required	integer <int32>

Responses

200

get /api/comment/comment_id

/api/comment/comment_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:37Z",
"source": "string",
"origin": "string",
"attachment_bytes": "string",
"text": "string",
"ctype": "text",
"author": "string",
"attachment_name": "string",
"attachment_type": "string",
"id": 0
},
"message": "string"
}

Update a comment

path Parameters

created_at required	string <date-time>
source required	string Nullable
origin required	string Nullable
attachment_bytes required	string Nullable
text required	string
ctype required	string <= 14 characters Nullable Enum: "text" "redshift" "classification"
author required	string
attachment_name required	string Nullable
attachment_type required	string Nullable
id required	integer <int32>

Responses

200

400

put /api/comment/comment_id

/api/comment/comment_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete a comment

path Parameters

comment_id

required

integer

Responses

200

delete /api/comment/comment_id

/api/comment/comment_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Retrieve a comment

path Parameters

created_at required	string <date-time>
source required	string Nullable
origin required	string Nullable
attachment_bytes required	string Nullable
text required	string
ctype required	string <= 14 characters Nullable Enum: "text" "redshift" "classification"
author required	string
attachment_name required	string Nullable
attachment_type required	string Nullable
id required	integer <int32>

Responses

200

get /api/comment/comment_id//action

/api/comment/comment_id//action

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:37Z",
"source": "string",
"origin": "string",
"attachment_bytes": "string",
"text": "string",
"ctype": "text",
"author": "string",
"attachment_name": "string",
"attachment_type": "string",
"id": 0
},
"message": "string"
}

Update a comment

path Parameters

created_at required	string <date-time>
source required	string Nullable
origin required	string Nullable
attachment_bytes required	string Nullable
text required	string
ctype required	string <= 14 characters Nullable Enum: "text" "redshift" "classification"
author required	string
attachment_name required	string Nullable
attachment_type required	string Nullable
id required	integer <int32>

Responses

200

400

put /api/comment/comment_id//

/api/comment/comment_id//

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete a comment

path Parameters

comment_id

required

integer

Responses

200

delete /api/comment/comment_id//

/api/comment/comment_id//

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Add a group user

path Parameters

group_id required	integer
username required	string
admin required	boolean

Responses

200

post /api/groups//group_id/users//username

/api/groups//group_id/users//username

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"group_id": 0,
"user_id": 0,
"admin": true
}

Delete a group user

path Parameters

group_id required	integer
username required	string

Responses

200

delete /api/groups//group_id/users//username

/api/groups//group_id/users//username

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Retrieve a group

path Parameters

group_id

required

integer

Responses

200

400

get /api/groups/group_id

/api/groups/group_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:38Z",
"users": 
["string"
],
"sources": 
["string"
],
"name": "string",
"group_users": 
["string"
],
"telescopes": 
["string"
],
"streams": 
["string"
],
"id": 0
},
"message": "string"
}

Update a group

path Parameters

created_at required	string <date-time>
users required	Array of strings
sources required	Array of strings
name required	string
group_users required	Array of strings
telescopes required	Array of strings
streams required	Array of strings
id required	integer <int32>

Responses

200

400

put /api/groups/group_id

/api/groups/group_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete a group

path Parameters

group_id

required

integer

Responses

200

delete /api/groups/group_id

/api/groups/group_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Retrieve all groups

Responses

200

400

get /api/groups

/api/groups

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
[
{"created_at": "2020-01-18T01:27:38Z",
"users": 
["string"
],
"sources": 
["string"
],
"name": "string",
"group_users": 
["string"
],
"telescopes": 
["string"
],
"streams": 
["string"
],
"id": 0
}
],
"message": "string"
}

Create a new group

path Parameters

created_at required	string <date-time>
users required	Array of strings
sources required	Array of strings
name required	string
group_users required	Array of strings
telescopes required	Array of strings
streams required	Array of strings
id required	integer <int32>

Responses

200

post /api/groups/

/api/groups/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

Retrieve an instrument

path Parameters

instrument_id

required

integer

Responses

200

400

get /api/instrument/instrument_id

/api/instrument/instrument_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:38Z",
"spectra": 
["string"
],
"telescope": "string",
"name": "string",
"type": "string",
"band": "string",
"photometry": 
["string"
],
"id": 0
},
"message": "string"
}

Update instrument

path Parameters

created_at required	string <date-time>
spectra required	Array of strings
telescope required	string Nullable
name required	string
type required	string
band required	string
photometry required	Array of strings
id required	integer <int32>

Responses

200

400

put /api/instrument/instrument_id

/api/instrument/instrument_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete an instrument

path Parameters

instrument_id

required

integer

Responses

200

400

delete /api/instrument/instrument_id

/api/instrument/instrument_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Create instruments

path Parameters

created_at required	string <date-time>
spectra required	Array of strings
telescope required	string Nullable
name required	string
type required	string
band required	string
photometry required	Array of strings
id required	integer <int32>

Responses

200

post /api/instrument/

/api/instrument/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

Retrieve photometry

path Parameters

photometry_id

required

integer

Responses

200

400

get /api/photometry/photometry_id

/api/photometry/photometry_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:38Z",
"var_e_mag": 0,
"candid": 0,
"instrument": "string",
"observed_at": "2020-01-18T01:27:38Z",
"time_format": "string",
"mag": 0,
"filter": "string",
"origin": "string",
"time_scale": "string",
"var_mag": 0,
"id": 0,
"source": "string",
"score": 0,
"dist_nearest_source": 0,
"mjd": 0,
"e_mag_nearest_source": 0,
"lim_mag": 0,
"e_mag": 0,
"altdata": "string",
"thumbnails": 
["string"
],
"mag_nearest_source": 0,
"isdiffpos": true
},
"message": "string"
}

Update photometry

path Parameters

created_at required	string <date-time>
var_e_mag required	number <float> Nullable
candid required	integer <int32> Nullable
instrument required	string Nullable
observed_at required	string <date-time> Nullable
time_format required	string Nullable
mag required	number <float> Nullable
filter required	string Nullable
origin required	string Nullable
time_scale required	string Nullable
var_mag required	number <float> Nullable
id required	integer <int32>
source required	string Nullable
score required	number <float> Nullable
dist_nearest_source required	number <float> Nullable
mjd required	number <float> Nullable
e_mag_nearest_source required	number <float> Nullable
lim_mag required	number <float> Nullable
e_mag required	number <float> Nullable
altdata required	string Nullable
thumbnails required	Array of strings
mag_nearest_source required	number <float> Nullable
isdiffpos required	boolean Nullable

Responses

200

400

put /api/photometry/photometry_id

/api/photometry/photometry_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete photometry

path Parameters

photometry_id

required

integer

Responses

200

400

delete /api/photometry/photometry_id

/api/photometry/photometry_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Upload photometry

path Parameters

time_format required	string Valid time formats are listed in `astropy.time.Time.FORMATS` (https://docs.astropy.org/en/stable/api/astropy.time.Time.html#astropy.time.Time.FORMATS)
time_scale required	string Valid time scales are listed in `astropy.time.Time.SCALES` (https://docs.astropy.org/en/stable/api/astropy.time.Time.html#astropy.time.Time.SCALES)
source_id required	string
instrument_id required	integer
time required	string
mag required	number
e_mag required	number
filter required	string
lim_mag required	number
thumbnails required	Array of objects

Responses

200

post /api/photometry/

/api/photometry/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ids": [ ]
}

Retrieve a source's photometry

path Parameters

source_id

required

string

Responses

200

400

get /api/sources/source_id/photometry

/api/sources/source_id/photometry

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
[
{"created_at": "2020-01-18T01:27:38Z",
"var_e_mag": 0,
"candid": 0,
"instrument": "string",
"observed_at": "2020-01-18T01:27:38Z",
"time_format": "string",
"mag": 0,
"filter": "string",
"origin": "string",
"time_scale": "string",
"var_mag": 0,
"id": 0,
"source": "string",
"score": 0,
"dist_nearest_source": 0,
"mjd": 0,
"e_mag_nearest_source": 0,
"lim_mag": 0,
"e_mag": 0,
"altdata": "string",
"thumbnails": 
["string"
],
"mag_nearest_source": 0,
"isdiffpos": true
}
],
"message": "string"
}

Retrieve a source

path Parameters

source_id

required

integer

Responses

200

400

get /api/sources/source_id

/api/sources/source_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"redshift": 0,
"created_at": "2020-01-18T01:27:38Z",
"simbad_info": "string",
"srmag1": 0,
"dec": 0,
"groups": 
["string"
],
"objectidps1": 0,
"gaia_info": "string",
"origin": "string",
"dec_err": 0,
"offset": 0,
"ra": 0,
"simbad_class": "string",
"ra_err": 0,
"detect_photometry_count": 0,
"sgscore1": 0,
"id": "string",
"tns_name": "string",
"users": 
["string"
],
"ra_dis": 0,
"distpsnr1": 0,
"tns_info": "string",
"score": 0,
"dist_nearest_source": 0,
"photometry": 
["string"
],
"modified": "2020-01-18T01:27:38Z",
"varstar": true,
"dec_dis": 0,
"last_detected": "2020-01-18T01:27:38Z",
"spectra": 
["string"
],
"simag1": 0,
"e_mag_nearest_source": 0,
"comments": 
["string"
],
"is_roid": true,
"altdata": "string",
"thumbnails": 
["string"
],
"sgmag1": 0,
"mag_nearest_source": 0,
"transient": true
},
"message": "string"
}

Update a source

path Parameters

redshift required	number <float> Nullable
created_at required	string <date-time>
simbad_info required	string Nullable
srmag1 required	number <float> Nullable
dec required	number <float> Nullable
groups required	Array of strings
objectidps1 required	integer <int32> Nullable
gaia_info required	string Nullable
origin required	string Nullable
dec_err required	number <float> Nullable
offset required	number <float> Nullable
ra required	number <float> Nullable
simbad_class required	string Nullable
ra_err required	number <float> Nullable
detect_photometry_count required	integer <int32> Nullable
sgscore1 required	number <float> Nullable
id required	string
tns_name required	string Nullable
users required	Array of strings
ra_dis required	number <float> Nullable
distpsnr1 required	number <float> Nullable
tns_info required	string Nullable
score required	number <float> Nullable
dist_nearest_source required	number <float> Nullable
photometry required	Array of strings
modified required	string <date-time>
varstar required	boolean Nullable
dec_dis required	number <float> Nullable
last_detected required	string <date-time> Nullable
spectra required	Array of strings
simag1 required	number <float> Nullable
e_mag_nearest_source required	number <float> Nullable
comments required	Array of strings
is_roid required	boolean Nullable
altdata required	string Nullable
thumbnails required	Array of strings
sgmag1 required	number <float> Nullable
mag_nearest_source required	number <float> Nullable
transient required	boolean Nullable

Responses

200

400

put /api/sources/source_id

/api/sources/source_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete a source

path Parameters

redshift required	number <float> Nullable
created_at required	string <date-time>
simbad_info required	string Nullable
srmag1 required	number <float> Nullable
dec required	number <float> Nullable
groups required	Array of strings
objectidps1 required	integer <int32> Nullable
gaia_info required	string Nullable
origin required	string Nullable
dec_err required	number <float> Nullable
offset required	number <float> Nullable
ra required	number <float> Nullable
simbad_class required	string Nullable
ra_err required	number <float> Nullable
detect_photometry_count required	integer <int32> Nullable
sgscore1 required	number <float> Nullable
id required	string
tns_name required	string Nullable
users required	Array of strings
ra_dis required	number <float> Nullable
distpsnr1 required	number <float> Nullable
tns_info required	string Nullable
score required	number <float> Nullable
dist_nearest_source required	number <float> Nullable
photometry required	Array of strings
modified required	string <date-time>
varstar required	boolean Nullable
dec_dis required	number <float> Nullable
last_detected required	string <date-time> Nullable
spectra required	Array of strings
simag1 required	number <float> Nullable
e_mag_nearest_source required	number <float> Nullable
comments required	Array of strings
is_roid required	boolean Nullable
altdata required	string Nullable
thumbnails required	Array of strings
sgmag1 required	number <float> Nullable
mag_nearest_source required	number <float> Nullable
transient required	boolean Nullable

Responses

200

delete /api/sources/source_id

/api/sources/source_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Retrieve all sources

Responses

200

400

get /api/sources

/api/sources

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
[
{"redshift": 0,
"created_at": "2020-01-18T01:27:38Z",
"simbad_info": "string",
"srmag1": 0,
"dec": 0,
"groups": 
["string"
],
"objectidps1": 0,
"gaia_info": "string",
"origin": "string",
"dec_err": 0,
"offset": 0,
"ra": 0,
"simbad_class": "string",
"ra_err": 0,
"detect_photometry_count": 0,
"sgscore1": 0,
"id": "string",
"tns_name": "string",
"users": 
["string"
],
"ra_dis": 0,
"distpsnr1": 0,
"tns_info": "string",
"score": 0,
"dist_nearest_source": 0,
"photometry": 
["string"
],
"modified": "2020-01-18T01:27:38Z",
"varstar": true,
"dec_dis": 0,
"last_detected": "2020-01-18T01:27:38Z",
"spectra": 
["string"
],
"simag1": 0,
"e_mag_nearest_source": 0,
"comments": 
["string"
],
"is_roid": true,
"altdata": "string",
"thumbnails": 
["string"
],
"sgmag1": 0,
"mag_nearest_source": 0,
"transient": true
}
],
"message": "string"
}

Upload a source. If group_ids is not specified, th

Upload a source. If group_ids is not specified, the user or token's groups will be used.

path Parameters

redshift required	number <float> Nullable
created_at required	string <date-time>
simbad_info required	string Nullable
srmag1 required	number <float> Nullable
dec required	number <float> Nullable
groups required	Array of strings
objectidps1 required	integer <int32> Nullable
gaia_info required	string Nullable
origin required	string Nullable
dec_err required	number <float> Nullable
offset required	number <float> Nullable
ra required	number <float> Nullable
simbad_class required	string Nullable
ra_err required	number <float> Nullable
detect_photometry_count required	integer <int32> Nullable
sgscore1 required	number <float> Nullable
id required	string
tns_name required	string Nullable
users required	Array of strings
ra_dis required	number <float> Nullable
distpsnr1 required	number <float> Nullable
tns_info required	string Nullable
score required	number <float> Nullable
dist_nearest_source required	number <float> Nullable
photometry required	Array of strings
modified required	string <date-time>
varstar required	boolean Nullable
dec_dis required	number <float> Nullable
last_detected required	string <date-time> Nullable
spectra required	Array of strings
simag1 required	number <float> Nullable
e_mag_nearest_source required	number <float> Nullable
comments required	Array of strings
is_roid required	boolean Nullable
altdata required	string Nullable
thumbnails required	Array of strings
sgmag1 required	number <float> Nullable
mag_nearest_source required	number <float> Nullable
transient required	boolean Nullable

Responses

200

post /api/sources/

/api/sources/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string"
}

Retrieve a spectrum

path Parameters

spectrum_id

required

integer

Responses

200

400

get /api/spectrum/spectrum_id

/api/spectrum/spectrum_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:38Z",
"source": "string",
"errors": 
[0
],
"origin": "string",
"wavelengths": 
[0
],
"instrument": "string",
"observed_at": "2020-01-18T01:27:38Z",
"fluxes": 
[0
],
"id": 0
},
"message": "string"
}

Update spectrum

path Parameters

created_at required	string <date-time>
source required	string Nullable
errors required	Array of numbers <float> Nullable
origin required	string Nullable
wavelengths required	Array of numbers <float>
instrument required	string Nullable
observed_at required	string <date-time>
fluxes required	Array of numbers <float>
id required	integer <int32>

Responses

200

400

put /api/spectrum/spectrum_id

/api/spectrum/spectrum_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete a spectrum

path Parameters

spectrum_id

required

integer

Responses

200

400

delete /api/spectrum/spectrum_id

/api/spectrum/spectrum_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Upload spectrum

path Parameters

created_at required	string <date-time>
source required	string Nullable
errors required	Array of numbers <float> Nullable
origin required	string Nullable
wavelengths required	Array of numbers <float>
instrument required	string Nullable
observed_at required	string <date-time>
fluxes required	Array of numbers <float>
id required	integer <int32>

Responses

200

post /api/spectrum/

/api/spectrum/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

Retrieve system info

Responses

200

get /api/sysinfo

/api/sysinfo

Response samples

Content type

application/json

Copy

Expand all Collapse all

{ }

Retrieve a telescope

path Parameters

telescope_id

required

integer

Responses

200

400

get /api/telescope/telescope_id

/api/telescope/telescope_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:38Z",
"instruments": 
["string"
],
"name": "string",
"lat": 0,
"groups": 
["string"
],
"nickname": "string",
"lon": 0,
"diameter": 0,
"id": 0,
"elevation": 0
},
"message": "string"
}

Update telescope

path Parameters

created_at required	string <date-time>
instruments required	Array of strings
name required	string
lat required	number <float>
groups required	Array of strings
nickname required	string
lon required	number <float>
diameter required	number <float>
id required	integer <int32>
elevation required	number <float>

Responses

200

400

put /api/telescope/telescope_id

/api/telescope/telescope_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete a telescope

path Parameters

telescope_id

required

integer

Responses

200

400

delete /api/telescope/telescope_id

/api/telescope/telescope_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Create telescopes

path Parameters

created_at required	string <date-time>
instruments required	Array of strings
name required	string
lat required	number <float>
groups required	Array of strings
nickname required	string
lon required	number <float>
diameter required	number <float>
id required	integer <int32>
elevation required	number <float>

Responses

200

post /api/telescope/

/api/telescope/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

Retrieve a thumbnail

path Parameters

thumbnail_id

required

integer

Responses

200

400

get /api/thumbnail/thumbnail_id

/api/thumbnail/thumbnail_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:38Z",
"file_uri": "string",
"source": "string",
"origin": "string",
"type": "new",
"photometry": "string",
"public_url": "string",
"id": 0
},
"message": "string"
}

Update thumbnail

path Parameters

created_at required	string <date-time>
file_uri required	string Nullable
source required	string Nullable
origin required	string Nullable
type required	string <= 6 characters Nullable Enum: "new" "ref" "sub" "sdss" "dr8" "new_gz" "ref_gz" "sub_gz"
photometry required	string Nullable
public_url required	string Nullable
id required	integer <int32>

Responses

200

400

put /api/thumbnail/thumbnail_id

/api/thumbnail/thumbnail_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete a thumbnail

path Parameters

thumbnail_id

required

integer

Responses

200

400

delete /api/thumbnail/thumbnail_id

/api/thumbnail/thumbnail_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Upload thumbnails

path Parameters

source_id required	string ID of source associated with thumbnails. If specified, without `photometry_id`, the first photometry point associated with specified source will be associated with thumbnail(s).
photometry_id required	integer ID of photometry to be associated with thumbnails. If omitted, `source_id` must be specified, in which case the first photometry entry associated with source will be used.
data required	string <byte> base64-encoded PNG image file contents. Image size must be between 100px and 500px on a side.
ttype required	string Thumbnail type. Must be one of 'new', 'ref', 'sub', 'sdss', 'dr8', 'new_gz', 'ref_gz', 'sub_gz'

Responses

200

post /api/thumbnail/

/api/thumbnail/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": null
}

Retrieve a user

path Parameters

user_id

required

integer

Responses

200

400

get /api/user/user_id

/api/user/user_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:38Z",
"username": "string",
"sources": 
["string"
],
"acls": 
["string"
],
"groups": 
["string"
],
"group_users": 
["string"
],
"tokens": 
["string"
],
"id": 0,
"roles": 
["string"
]
},
"message": "string"
}

Delete a user

path Parameters

user_id

required

integer

Responses

200

400

delete /api/user/user_id

/api/user/user_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Generate new token

path Parameters

created_at required	string <date-time>
created_by required	string Nullable
name required	string
acls required	Array of strings
id required	string

Responses

200

post /api/internal/tokens/

/api/internal/tokens/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Delete a token

path Parameters

token_id

required

integer

Responses

200

400

delete /api/internal/tokens/token_id

/api/internal/tokens/token_id

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"message": "string"
}

Retrieve user profile

Responses

200

get /api/internal/profile

/api/internal/profile

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "success",
"data": 
{"created_at": "2020-01-18T01:27:38Z",
"username": "string",
"sources": 
["string"
],
"acls": 
["string"
],
"groups": 
["string"
],
"group_users": 
["string"
],
"tokens": 
["string"
],
"id": 0,
"roles": 
["string"
]
},
"message": "string"
}

Determine whether sources table is empy.

Responses

200

get /api/internal/dbinfo

/api/internal/dbinfo

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"source_table_empty": true
}

SkyPortal (0.9.dev0+git20200117.33ee6b9)

Authentication

token

Retrieve a comment

path Parameters

Responses

Response samples

Update a comment

path Parameters

Responses

Response samples

Delete a comment

path Parameters

Responses

Response samples

Post a comment

path Parameters

Responses

Response samples

Retrieve a comment

path Parameters

Responses

Response samples

Update a comment

path Parameters

Responses

Response samples

Delete a comment

path Parameters

Responses

Response samples

Post a comment

path Parameters

Responses

Response samples

Add a group user

path Parameters

Responses

Response samples

Delete a group user

path Parameters

Responses

Response samples

Retrieve a group

path Parameters

Responses

Response samples

Update a group

path Parameters

Responses

Response samples

Delete a group

path Parameters

Responses

Response samples

Retrieve all groups

Responses

Response samples

Create a new group

path Parameters

Responses

Response samples

Retrieve an instrument

path Parameters

Responses

Response samples

Update instrument

path Parameters

Responses

Response samples

Delete an instrument

path Parameters

Responses

Response samples

Create instruments

path Parameters

Responses

Response samples

Retrieve photometry

path Parameters