@@ -2,7 +2,7 @@ openapi: 3.0.0
22info :
33 version : 0.9.0
44 title : Glean API
5- x-source-commit-sha : 56c08697ca3b6869022a262114e61f1385914425
5+ x-source-commit-sha : 71f6f010ec8460f560090a540dab0a65536891e5
66 description : |
77 # Introduction
88 In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean.
2222 These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice.
2323 x-logo :
2424 url : https://app.glean.com/images/glean-text2.svg
25- x-open-api-commit-sha : daa8736a6f0763faffd2c1079da8a42345536ed7
25+ x-open-api-commit-sha : cea6dc858e444cf80623f1b987244690fce6be9e
2626 x-speakeasy-name : ' Glean API'
2727servers :
2828 - url : https://{instance}-be.glean.com
@@ -3122,6 +3122,13 @@ paths:
31223122 description : Not Authorized
31233123 " 409 " :
31243124 description : Conflict
3125+ deprecated : true
3126+ x-speakeasy-deprecation-message : " Deprecated on 2026-02-03, removal scheduled for 2026-10-15: Endpoint is deprecated"
3127+ x-glean-deprecated :
3128+ id : ce596f49-55c4-465e-bf3c-5a3a33906e1f
3129+ introduced : " 2026-02-03"
3130+ message : Endpoint is deprecated
3131+ removal : " 2026-10-15"
31253132 x-speakeasy-name-override : bulkIndex
31263133 x-speakeasy-group : indexing.people
31273134 /api/index/v1/indexemployeelist : {}
@@ -3676,6 +3683,89 @@ paths:
36763683 " 500 " :
36773684 description : Internal error
36783685 x-visibility : Public
3686+ /rest/api/v1/configure/datasources/{datasourceId}/instances/{instanceId} :
3687+ get :
3688+ operationId : getDatasourceInstanceConfiguration
3689+ summary : Get datasource instance configuration
3690+ description : |
3691+ Gets the greenlisted configuration values for a datasource instance. Returns only configuration keys that are exposed via the public API greenlist.
3692+ tags :
3693+ - Datasources
3694+ parameters :
3695+ - $ref : ' #/components/parameters/datasourceId'
3696+ - $ref : ' #/components/parameters/instanceId'
3697+ responses :
3698+ " 200 " :
3699+ description : OK
3700+ content :
3701+ application/json :
3702+ schema :
3703+ $ref : ' #/components/schemas/DatasourceConfigurationResponse'
3704+ " 400 " :
3705+ description : Invalid request
3706+ content :
3707+ application/json :
3708+ schema :
3709+ $ref : ' #/components/schemas/ErrorResponse'
3710+ " 401 " :
3711+ description : Not authorized
3712+ " 403 " :
3713+ description : Forbidden
3714+ content :
3715+ application/json :
3716+ schema :
3717+ $ref : ' #/components/schemas/ErrorResponse'
3718+ " 404 " :
3719+ description : Datasource instance not found
3720+ content :
3721+ application/json :
3722+ schema :
3723+ $ref : ' #/components/schemas/ErrorResponse'
3724+ x-visibility : Preview
3725+ patch :
3726+ operationId : updateDatasourceInstanceConfiguration
3727+ summary : Update datasource instance configuration
3728+ description : |
3729+ Updates the greenlisted configuration values for a datasource instance. Only configuration keys that are exposed via the public API greenlist may be set. Returns the full greenlisted configuration after the update is applied.
3730+ tags :
3731+ - Datasources
3732+ parameters :
3733+ - $ref : ' #/components/parameters/datasourceId'
3734+ - $ref : ' #/components/parameters/instanceId'
3735+ requestBody :
3736+ content :
3737+ application/json :
3738+ schema :
3739+ $ref : ' #/components/schemas/UpdateDatasourceConfigurationRequest'
3740+ required : true
3741+ responses :
3742+ " 200 " :
3743+ description : OK
3744+ content :
3745+ application/json :
3746+ schema :
3747+ $ref : ' #/components/schemas/DatasourceConfigurationResponse'
3748+ " 400 " :
3749+ description : Invalid request
3750+ content :
3751+ application/json :
3752+ schema :
3753+ $ref : ' #/components/schemas/ErrorResponse'
3754+ " 401 " :
3755+ description : Not authorized
3756+ " 403 " :
3757+ description : Forbidden
3758+ content :
3759+ application/json :
3760+ schema :
3761+ $ref : ' #/components/schemas/ErrorResponse'
3762+ " 404 " :
3763+ description : Datasource instance not found
3764+ content :
3765+ application/json :
3766+ schema :
3767+ $ref : ' #/components/schemas/ErrorResponse'
3768+ x-visibility : Preview
36793769 /rest/api/v1/chat#stream:
36803770 post :
36813771 tags :
@@ -6547,16 +6637,34 @@ components:
65476637 deprecated : true
65486638 description : The person that invited this person.
65496639 $ref : " #/components/schemas/Person"
6640+ x-glean-deprecated :
6641+ id : 1d3cd23f-9085-4378-b466-9bdc2e344a71
6642+ introduced : " 2026-02-05"
6643+ message : Use ChannelInviteInfo instead
6644+ removal : " 2026-10-15"
6645+ x-speakeasy-deprecation-message : " Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use ChannelInviteInfo instead"
65506646 inviteTime :
65516647 deprecated : true
65526648 type : string
65536649 format : date-time
65546650 description : The time this person was invited in ISO format (ISO 8601).
6651+ x-glean-deprecated :
6652+ id : 2dc3f572-cded-483d-af07-fc9fc7fd0ae4
6653+ introduced : " 2026-02-05"
6654+ message : Use ChannelInviteInfo instead
6655+ removal : " 2026-10-15"
6656+ x-speakeasy-deprecation-message : " Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use ChannelInviteInfo instead"
65556657 reminderTime :
65566658 deprecated : true
65576659 type : string
65586660 format : date-time
65596661 description : The time this person was reminded in ISO format (ISO 8601) if a reminder was sent.
6662+ x-glean-deprecated :
6663+ id : d02d58cf-eb90-45d0-ab90-f7a9d707ae3c
6664+ introduced : " 2026-02-05"
6665+ message : Use ChannelInviteInfo instead
6666+ removal : " 2026-10-15"
6667+ x-speakeasy-deprecation-message : " Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use ChannelInviteInfo instead"
65606668 ReadPermission :
65616669 description : Describes the read permission level that a user has for a specific feature
65626670 properties :
@@ -8107,9 +8215,12 @@ components:
81078215 description : Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming.
81088216 additionalProperties : true
81098217 ErrorResponse :
8110- type : string
8111- title : ErrorResponse
8112- description : Error message returned from the server
8218+ type : object
8219+ description : Error response returned for failed requests
8220+ properties :
8221+ message :
8222+ type : string
8223+ description : Client-facing error message describing what went wrong
81138224 ActionSummary :
81148225 type : object
81158226 description : Represents a minimal summary of an action.
@@ -13217,6 +13328,49 @@ components:
1321713328 items :
1321813329 type : string
1321913330 description : List of field names to exclude from the export
13331+ ConfigurationValue :
13332+ type : object
13333+ properties :
13334+ value :
13335+ type : string
13336+ description : The configuration value as a string. Only one of value or valueList should be populated.
13337+ valueList :
13338+ type : array
13339+ items :
13340+ type : string
13341+ description : The configuration value as a list of strings. Only one of value or valueList should be populated.
13342+ description : A single configuration value, either a scalar or a list
13343+ ConfigurationValues :
13344+ type : object
13345+ additionalProperties :
13346+ $ref : ' #/components/schemas/ConfigurationValue'
13347+ description : A map from configuration key names to their values
13348+ DatasourceInstanceConfiguration :
13349+ type : object
13350+ properties :
13351+ values :
13352+ $ref : ' #/components/schemas/ConfigurationValues'
13353+ required :
13354+ - values
13355+ description : Configuration for a datasource instance
13356+ DatasourceConfigurationResponse :
13357+ type : object
13358+ properties :
13359+ configuration :
13360+ $ref : ' #/components/schemas/DatasourceInstanceConfiguration'
13361+ required :
13362+ - configuration
13363+ description : |
13364+ The greenlisted configuration values for a datasource instance. Only keys that are exposed via the public API greenlist are included.
13365+ UpdateDatasourceConfigurationRequest :
13366+ type : object
13367+ properties :
13368+ configuration :
13369+ $ref : ' #/components/schemas/DatasourceInstanceConfiguration'
13370+ required :
13371+ - configuration
13372+ description : |
13373+ Request to update greenlisted configuration values for a datasource instance. Only keys that are exposed via the public API greenlist may be set.
1322013374 ChatRequestStream :
1322113375 required :
1322213376 - messages
@@ -13274,6 +13428,22 @@ components:
1327413428 description : The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
1327513429 schema :
1327613430 type : integer
13431+ datasourceId :
13432+ name : datasourceId
13433+ in : path
13434+ description : The datasource type identifier (e.g. o365sharepoint)
13435+ required : true
13436+ schema :
13437+ type : string
13438+ example : o365sharepoint
13439+ instanceId :
13440+ name : instanceId
13441+ in : path
13442+ description : The datasource instance identifier
13443+ required : true
13444+ schema :
13445+ type : string
13446+ example : o365sharepoint_abc123
1327713447 responses :
1327813448 SuccessResponse :
1327913449 description : OK
0 commit comments