across.sdk.v1
Server providing tools and utilities for various NASA missions to aid in coordination of large observation efforts.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.6.0
- Package version: 1.0.0
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import across.sdk.v1
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import across.sdk.v1
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import across.sdk.v1
from across.sdk.v1.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /v1
# See configuration.py for a list of all supported configuration parameters.
configuration = across.sdk.v1.Configuration(
host = "/v1"
)
# Enter a context with an instance of the API client
with across.sdk.v1.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = across.sdk.v1.AuthApi(api_client)
email = 'email_example' # str |
try:
# Local Token
api_response = api_instance.local_token_auth_local_token_get(email)
print("The response of AuthApi->local_token_auth_local_token_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AuthApi->local_token_auth_local_token_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to /v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthApi | local_token_auth_local_token_get | GET /auth/local-token | Local Token |
| AuthApi | login | POST /auth/login | Login |
| AuthApi | refresh | POST /auth/refresh | Refresh Token |
| AuthApi | token | POST /auth/token | Token |
| AuthApi | verify | GET /auth/verify | Verify |
| BrokerAlertApi | create_broker_alert | POST /broker-alert/ | Create a BrokerAlert |
| BrokerAlertApi | get_broker_alert | GET /broker-alert/{broker_alert_id} | Read a broker alert |
| BrokerAlertApi | get_broker_alerts | GET /broker-alert/ | Read broker alert(s) |
| BrokerEventApi | get_broker_event | GET /broker-event/{broker_event_id} | Read a broker event |
| BrokerEventApi | get_broker_events | GET /broker-event/ | Read broker event(s) |
| FilterApi | get_filter_filter_id_get | GET /filter/{filter_id} | Read a filter |
| FilterApi | get_many_filter_get | GET /filter/ | Read filters(s) |
| GroupApi | get_group | GET /group/{group_id} | Read a group |
| GroupApi | get_many_group_get | GET /group/ | Read groups |
| GroupApi | remove_user | DELETE /group/{group_id}/user/{user_id} | Remove a user from a group |
| GroupInviteApi | delete_invite | DELETE /group/{group_id}/invite/{invite_id} | Delete a group invite |
| GroupInviteApi | get_invite | GET /group/{group_id}/invite/{invite_id} | Read a group invite |
| GroupInviteApi | get_invites | GET /group/{group_id}/invite | Read group invites |
| GroupInviteApi | send_invite | POST /group/{group_id}/invite | Create and send a group invite |
| GroupRoleApi | assign_to_user | PUT /group/{group_id}/user/{user_id}/role/{group_role_id} | Assign a group role to a user |
| GroupRoleApi | create_group_role | POST /group/{group_id}/role | Create a group role |
| GroupRoleApi | delete_group_role | DELETE /group/{group_id}/role/{group_role_id} | Delete a group role |
| GroupRoleApi | get_group_role | GET /group/{group_id}/role/{group_role_id} | Read a group role |
| GroupRoleApi | get_group_roles | GET /group/{group_id}/role | Read group roles |
| GroupRoleApi | remove_from_user | DELETE /group/{group_id}/user/{user_id}/role/{group_role_id} | Remove a group role from a user |
| GroupRoleApi | update_group_role | PUT /group/{group_id}/role/{group_role_id} | Update a group role |
| InstrumentApi | get_instrument | GET /instrument/{instrument_id} | Read an instrument |
| InstrumentApi | get_instruments | GET /instrument/ | Read instruments(s) |
| InternalApi | get_service_account | GET /service-account/{service_account_id} | Get a system service account |
| InternalApi | service_account_rotate_key | PATCH /service-account/{service_account_id}/rotate-key | Rotate a service account key |
| ObservationApi | contains_point | GET /observation/search/contains-point/ | Read many observations whose footprints contains a given RA/DEC |
| ObservationApi | get_observation | GET /observation/{observation_id} | Read an observation |
| ObservationApi | get_observations | GET /observation/ | Read observations(s) |
| ObservatoryApi | get_observatories | GET /observatory/ | Read observatory(s) |
| ObservatoryApi | get_observatory | GET /observatory/{observatory_id} | Read an observatory |
| PermissionApi | get_permissions | GET /permission/ | Read permissions |
| RoleApi | get_many_role_get | GET /role/ | Read roles |
| RoleApi | get_role_role_id_get | GET /role/{role_id} | Read a role |
| ScheduleApi | create_many_schedules | POST /schedule/bulk | Create many Schedules |
| ScheduleApi | create_schedule | POST /schedule/ | Create a Schedule |
| ScheduleApi | get_schedule | GET /schedule/{schedule_id} | Read a schedule |
| ScheduleApi | get_schedules | GET /schedule/ | Read schedule(s) |
| ScheduleApi | get_schedules_history | GET /schedule/history | Read schedule(s) |
| ServiceAccountApi | assign_to_service_account | POST /user/{user_id}/service-account/{service_account_id}/group-role/{group_role_id} | Assign group role |
| ServiceAccountApi | create_user_service_account | POST /user/{user_id}/service-account/ | Create a service account |
| ServiceAccountApi | delete_user_service_account | DELETE /user/{user_id}/service-account/{service_account_id} | Delete a service_account |
| ServiceAccountApi | get_service_accounts | GET /user/{user_id}/service-account/ | Read service accounts |
| ServiceAccountApi | get_user_service_account | GET /user/{user_id}/service-account/{service_account_id} | Read a service account |
| ServiceAccountApi | remove_from_service_account | DELETE /user/{user_id}/service-account/{service_account_id}/group-role/{group_role_id} | Remove group role |
| ServiceAccountApi | update_user_service_account | PATCH /user/{user_id}/service-account/{service_account_id} | Update a service account |
| ServiceAccountApi | user_service_account_rotate_key | PATCH /user/{user_id}/service-account/{service_account_id}/rotate-key | Rotate a service account key |
| TLEApi | create_tle | POST /tle/ | Create a TLE |
| TelescopeApi | get_telescope | GET /telescope/{telescope_id} | Read an telescope |
| TelescopeApi | get_telescopes | GET /telescope/ | Read telescopes(s) |
| ToolsApi | calculate_joint_windows_tools_visibility_calculator_windows_get | GET /tools/visibility-calculator/windows/ | Calculated Joint Visibility Windows |
| ToolsApi | calculate_joint_windows_tools_visibility_calculator_windows_get_0 | GET /tools/visibility-calculator/windows/ | Calculated Joint Visibility Windows |
| ToolsApi | calculate_windows_tools_visibility_calculator_windows_instrument_id_get | GET /tools/visibility-calculator/windows/{instrument_id} | Calculated Visibility Windows |
| ToolsApi | calculate_windows_tools_visibility_calculator_windows_instrument_id_get_0 | GET /tools/visibility-calculator/windows/{instrument_id} | Calculated Visibility Windows |
| ToolsApi | resolve_tools_resolve_object_get | GET /tools/resolve-object/ | Resolve an object name |
| ToolsApi | resolve_tools_resolve_object_get_0 | GET /tools/resolve-object/ | Resolve an object name |
| UserApi | accept_invite | PATCH /user/{user_id}/invite/{invite_id} | Accept a group invitation |
| UserApi | create_user | POST /user/ | Create a user |
| UserApi | decline_invite | DELETE /user/{user_id}/invite/{invite_id} | Decline a group invitation |
| UserApi | delete_user | DELETE /user/{user_id} | Deactivate a user |
| UserApi | get_group_invites | GET /user/{user_id}/invite | Read a user's group invites |
| UserApi | get_many_user_get | GET /user/ | Read users |
| UserApi | get_user | GET /user/{user_id} | Read a user |
| UserApi | leave_group | DELETE /user/{user_id}/group/{group_id} | Leave a group |
| UserApi | update_user | PATCH /user/{user_id} | Update a user |
Documentation For Models
- AccessTokenResponse
- AcrossServerRoutesV1GroupRoleSchemasGroup
- AcrossServerRoutesV1GroupRoleSchemasUser
- AcrossServerRoutesV1GroupSchemasGroup
- AcrossServerRoutesV1GroupSchemasUser
- AcrossServerRoutesV1RoleSchemasUser
- AcrossServerRoutesV1UserSchemasGroupInvite
- AcrossServerRoutesV1UserSchemasGroupRole
- AcrossServerRoutesV1UserServiceAccountSchemasServiceAccount
- Bandpass
- BandpassType
- BrokerAlert
- BrokerAlertCreate
- BrokerAlertDataSource
- BrokerAlertStatus
- BrokerEvent
- BrokerEventType
- ConstrainedDate
- ConstraintReason
- ConstraintType
- Coordinate
- DateRange
- DepthUnit
- EnergyBandpass
- EnergyUnit
- EphemerisType
- Filter
- FrequencyBandpass
- FrequencyUnit
- GrantType
- GroundParameters
- Group
- GroupBase
- GroupInvite
- GroupInviteCreate
- GroupInviteGroupDetails
- GroupRead
- GroupRole
- GroupRoleCreate
- GroupRoleRead
- HTTPValidationError
- IDNameSchema
- IVOAObsCategory
- IVOAObsTrackingType
- Instrument
- JPLParameters
- JointVisibilityResult
- Localization
- LocalizationContourBase
- LocalizationCreate
- NameResolver
- NullableDateRange
- Observation
- ObservationCreate
- ObservationFootprint
- ObservationFootprintCreate
- ObservationStatus
- ObservationStrategy
- ObservationType
- Observatory
- ObservatoryEphemerisType
- ObservatoryType
- PageBrokerAlert
- PageBrokerEvent
- PageObservation
- PageSchedule
- Parameters
- Permission
- Point
- Role
- RoleBase
- SPICEParameters
- Schedule
- ScheduleCadence
- ScheduleCreate
- ScheduleCreateMany
- ScheduleFidelity
- ScheduleStatus
- ServiceAccount
- ServiceAccountCreate
- ServiceAccountSecret
- ServiceAccountUpdate
- SystemServiceAccount
- TLE
- TLECreate
- TLEParameters
- Telescope
- TelescopeInstrument
- UnitValue
- User
- UserCreate
- UserInfo
- UserUpdate
- ValidationError
- ValidationErrorLocInner
- VisibilityResult
- VisibilityType
- VisibilityWindow
- WavelengthBandpass
- WavelengthUnit
- Window
Documentation For Authorization
Authentication schemes defined for the API:
Authorization
- Type: Bearer authentication
ServiceAccountAuthorization
- Type: HTTP basic authentication
Author
Release files for across-server-openapi-python 1.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| across_server_openapi_python-1.4.0.tar.gz | 98.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| across_server_openapi_python-1.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 339.4 kB
Release files / across_server_openapi_python-1.4.0.tar.gz
| Download URL | across_server_openapi_python-1.4.0.tar.gz |
|---|---|
| Size | 98.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ca3760b7a790fc4ba2c0907017e2a2185ae6860607bc5669488294d8572cfa04
|
|
BLAKE2b-256 checksum How to use checksums |
1822236101ad0d479cbdeed0ab6daf55f7e3e48fa290ab00c6a1a7fa8b1f922b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 15, 2026.
Transparency logRelease files / across_server_openapi_python-1.4.0-py3-none-any.whl
| Download URL | across_server_openapi_python-1.4.0-py3-none-any.whl |
|---|---|
| Size | 240.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2fb014f77e64f44ad2f67b0e7cb61497315e323572c55f31d53ae6c4383ffadf
|
|
BLAKE2b-256 checksum How to use checksums |
c2d3a03c28aa5cc1794064540b1bfebcf1d815df25b434ce460b5cdd81fab50e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 15, 2026.
Transparency log