api

May 15, 2026

Changes in this version

+ type ConnectionInfo struct

+ DatabaseName string

+ DatabaseUID uuid.UUID

+ Format string

+ Protocol string

+ URL string

+ func BuildConnectionURL(db *store.Database, user *store.User, endpoints store.ResolvedEndpoints, ...) (ConnectionInfo, bool)

type CreateAPIKeyResponse

+ Connections []ConnectionInfo

+ ConnectionsTruncated bool

type CreateDatabaseRequest

+ Listable *bool

type DatabaseResponse

+ Listable bool

type UpdateDatabaseRequest

+ Listable *bool

May 10, 2026

Changes in this version

+ type CreateGrantDefinitionRequest struct

+ Controls []string

+ Description string

+ DurationSeconds int64

+ MaxBytesTransferred *int64

+ MaxQueryCounts *int64

+ Name string

+ type CreateGrantRequestRequest struct

+ DatabaseID uuid.UUID

+ GrantDefinitionID uuid.UUID

+ Justification string

+ type DenyGrantRequestRequest struct

+ Reason string

type ErrorCode

+ const ErrCodeConflict

+ type UpdateGrantDefinitionRequest = CreateGrantDefinitionRequest

Apr 4, 2026

Changes in this version

type CreateDatabaseRequest

+ OracleServiceName string

+ Protocol string

type DatabaseResponse

+ OracleServiceName string

+ Protocol string

+ type ErrorBody struct

+ Code ErrorCode

+ Detail string

+ Message string

+ RetryAfter int

+ type ErrorCode string

+ const ErrCodeDuplicateName

+ const ErrCodeForbidden

+ const ErrCodeGrantExpired

+ const ErrCodeInternalError

+ const ErrCodeInvalidCredentials

+ const ErrCodeNotFound

+ const ErrCodeOAuthFailed

+ const ErrCodeOAuthProviderError

+ const ErrCodeOAuthStateMismatch

+ const ErrCodeOAuthUserNotLinked

+ const ErrCodeOAuthWrongWorkspace

+ const ErrCodeQuotaExceeded

+ const ErrCodeRateLimited

+ const ErrCodeTargetMatchesSelf

+ const ErrCodeUnauthorized

+ const ErrCodeValidationError

+ const ErrCodeWeakPassword

type UpdateDatabaseRequest

+ OracleServiceName *string

+ Protocol *string

Jan 24, 2026

Changes in this version

+ type ResetPasswordRequest struct

+ NewPassword string

Jan 11, 2026

Changes in this version

+ const ErrCodeAuthRateLimited

+ const ErrCodePasswordChangeRequired

+ const FailureReasonInvalidPassword

+ const FailureReasonInvalidUsername

+ const FailureReasonPasswordChangeReq

+ const FailureReasonTokenExpired

+ const FailureReasonTokenInvalid

+ const FailureReasonTokenRevoked

+ const FailureReasonUserDeleted

+ const FailureReasonUserDisabled

+ var ErrInvalidUID = errors.New("invalid UID")

+ type ChangePasswordRequest struct

+ CurrentPassword string

+ NewPassword string

+ Username string

+ type CreateAPIKeyRequest struct

+ ExpiresAt *time.Time

+ Name string

+ type CreateAPIKeyResponse struct

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ ID uuid.UUID

+ Key string

+ KeyPrefix string

+ Name string

+ type CreateDatabaseRequest struct

+ DatabaseName string

+ Description string

+ Host string

+ Name string

+ Password string

+ Port int

+ SSLMode string

+ Username string

+ type CreateGrantRequest struct

+ Controls []string

+ DatabaseID uuid.UUID

+ ExpiresAt time.Time

+ MaxBytesTransferred *int64

+ MaxQueryCounts *int64

+ StartsAt time.Time

+ UserID uuid.UUID

+ type CreateUserRequest struct

+ Password string

+ Roles []string

+ Username string

+ type DatabaseLimitedResponse struct

+ Description string

+ Name string

+ UID uuid.UUID

+ type DatabaseResponse struct

+ CreatedBy *uuid.UUID

+ DatabaseName string

+ Description string

+ Host string

+ Name string

+ Port int

+ SSLMode string

+ UID uuid.UUID

+ Username string

+ type LoginRequest struct

+ Password string

+ Username string

+ type LoginResponse struct

+ ExpiresAt string

+ Token string

+ User UserResponse

+ type MeResponse struct

+ PasswordChangeRequired bool

+ Roles []string

+ Session SessionResponse

+ UID string

+ Username string

+ type PreLoginPasswordChangeRequest struct

+ CurrentPassword string

+ NewPassword string

+ Username string

+ type RateLimiter struct

+ func NewRateLimiter(cfg config.RateLimitConfig) *RateLimiter

+ func (rl *RateLimiter) GetStats(userID *uuid.UUID, ip string) (int, time.Time)

+ func (rl *RateLimiter) Middleware() gin.HandlerFunc

+ func (rl *RateLimiter) PostAuthMiddleware() gin.HandlerFunc

+ func (rl *RateLimiter) PreAuthMiddleware() gin.HandlerFunc

+ type Server struct

+ func NewServer(dataStore *store.Store, encryptionKey []byte, logger *slog.Logger, ...) *Server

+ func (s *Server) Shutdown(ctx context.Context) error

+ func (s *Server) Start(addr string) error

+ type SessionResponse struct

+ CreatedAt string

+ ExpiresAt string

+ type UpdateDatabaseRequest struct

+ DatabaseName *string

+ Description *string

+ Host *string

+ Password *string

+ Port *int

+ SSLMode *string

+ Username *string

+ type UpdateUserRequest struct

+ Password *string

+ Roles []string

+ type UserResponse struct

+ PasswordChangeRequired bool

+ Roles []string

+ UID string

+ Username string