Skip to content

Commit 2b54b7e

Browse files
he2sshe2ss
authored
Merge pull request #5 from crowdsecurity/$main-7aa0b3c
Update python SDK version: 1.17.0
2 parents 7aa0b3c + 356f959 commit 2b54b7e

11 files changed

+173
-164
lines changed

‎README.md

+4-101
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# crowdsec_service_api - 1.16.0
1+
# crowdsec_service_api - 1.17.0
22

33

44
## Installation
@@ -7,105 +7,8 @@
77
pip install crowdsec_service_api
88
```
99

10-
## License
11-
12-
13-
14-
## API Endpoint services
15-
16-
[Blocklists](./doc/Blocklists.md)
17-
18-
[Integrations](./doc/Integrations.md)
19-
20-
[Info](./doc/Info.md)
21-
22-
## API Endpoint models
23-
24-
[ApiKeyCredentials](./doc/Models.md#apikeycredentials)
25-
26-
[BasicAuthCredentials](./doc/Models.md#basicauthcredentials)
27-
28-
[BlocklistAddIPsRequest](./doc/Models.md#blocklistaddipsrequest)
29-
30-
[BlocklistContentStats](./doc/Models.md#blocklistcontentstats)
31-
32-
[BlocklistCreateRequest](./doc/Models.md#blocklistcreaterequest)
33-
34-
[BlocklistCreateResponse](./doc/Models.md#blocklistcreateresponse)
35-
36-
[BlocklistDeleteIPsRequest](./doc/Models.md#blocklistdeleteipsrequest)
37-
38-
[BlocklistGetResponse](./doc/Models.md#blocklistgetresponse)
39-
40-
[BlocklistIncludeFilters](./doc/Models.md#blocklistincludefilters)
41-
42-
[BlocklistResponse](./doc/Models.md#blocklistresponse)
43-
44-
[BlocklistShareRequest](./doc/Models.md#blocklistsharerequest)
45-
46-
[BlocklistSources](./doc/Models.md#blocklistsources)
47-
48-
[BlocklistStats](./doc/Models.md#blockliststats)
49-
50-
[BlocklistSubscriberEntity](./doc/Models.md#blocklistsubscriberentity)
51-
52-
[BlocklistSubscribersResponse](./doc/Models.md#blocklistsubscribersresponse)
53-
54-
[BlocklistSubscription](./doc/Models.md#blocklistsubscription)
55-
56-
[BlocklistSubscriptionRequest](./doc/Models.md#blocklistsubscriptionrequest)
57-
58-
[BlocklistSubscriptionResponse](./doc/Models.md#blocklistsubscriptionresponse)
10+
# Usage
11+
You can access the full usage documentation [here](https://github.com/crowdsecurity/crowdsec-service-api-sdk-python/tree/main/doc).
5912

60-
[BlocklistUpdateRequest](./doc/Models.md#blocklistupdaterequest)
61-
62-
[BlocklistUsageStats](./doc/Models.md#blocklistusagestats)
63-
64-
[Body_uploadBlocklistContent](./doc/Models.md#body_uploadblocklistcontent)
65-
66-
[CtiAs](./doc/Models.md#ctias)
67-
68-
[CtiBehavior](./doc/Models.md#ctibehavior)
69-
70-
[CtiCategory](./doc/Models.md#cticategory)
71-
72-
[CtiCountry](./doc/Models.md#cticountry)
73-
74-
[CtiIp](./doc/Models.md#ctiip)
75-
76-
[CtiScenario](./doc/Models.md#ctiscenario)
77-
78-
[EntityType](./doc/Models.md#entitytype)
79-
80-
[HTTPValidationError](./doc/Models.md#httpvalidationerror)
81-
82-
[IntegrationCreateRequest](./doc/Models.md#integrationcreaterequest)
83-
84-
[IntegrationCreateResponse](./doc/Models.md#integrationcreateresponse)
85-
86-
[IntegrationGetResponse](./doc/Models.md#integrationgetresponse)
87-
88-
[IntegrationType](./doc/Models.md#integrationtype)
89-
90-
[IntegrationUpdateRequest](./doc/Models.md#integrationupdaterequest)
91-
92-
[IntegrationUpdateResponse](./doc/Models.md#integrationupdateresponse)
93-
94-
[Links](./doc/Models.md#links)
95-
96-
[OutputFormat](./doc/Models.md#outputformat)
97-
98-
[Page_BlocklistResponse_](./doc/Models.md#page_blocklistresponse_)
99-
100-
[Page_IntegrationGetResponse_](./doc/Models.md#page_integrationgetresponse_)
101-
102-
[Permission](./doc/Models.md#permission)
103-
104-
[PricingTiers](./doc/Models.md#pricingtiers)
105-
106-
[Share](./doc/Models.md#share)
107-
108-
[Stats](./doc/Models.md#stats)
13+
## License
10914

110-
[ValidationError](./doc/Models.md#validationerror)
111-
```

‎crowdsec_service_api/__pycache__/base_model.cpython-311.pyc

0 Bytes
Binary file not shown.

‎crowdsec_service_api/__pycache__/http_client.cpython-311.pyc

0 Bytes
Binary file not shown.

‎crowdsec_service_api/models.py

+7-12
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# generated by datamodel-codegen:
22
# filename: <stdin>
3-
# timestamp: 2024-06-13T13:59:52+00:00
3+
# timestamp: 2024-06-18T14:56:09+00:00
44

55
from __future__ import annotations
66

@@ -645,17 +645,12 @@ class BlocklistStats(BaseModelSdk):
645645
}
646646
),
647647
]
648-
usage_stats: Annotated[
649-
Optional[BlocklistUsageStats],
650-
Field(
651-
{
652-
'engines_subscribed_directly': 0,
653-
'engines_subscribed_through_org': 0,
654-
'engines_subscribed_through_tag': 0,
655-
'total_subscribed_engines': 0,
656-
}
657-
),
658-
]
648+
usage_stats: Optional[BlocklistUsageStats] = {
649+
'engines_subscribed_directly': 0,
650+
'engines_subscribed_through_org': 0,
651+
'engines_subscribed_through_tag': 0,
652+
'total_subscribed_engines': 0,
653+
}
659654
addition_2days: Annotated[Optional[int], Field(0, title='Addition 2Days')]
660655
addition_month: Annotated[Optional[int], Field(0, title='Addition Month')]
661656
suppression_2days: Annotated[Optional[int], Field(0, title='Suppression 2Days')]

‎crowdsec_service_api/services/__pycache__/__init__.cpython-311.pyc

0 Bytes
Binary file not shown.

‎doc/Blocklists.md

+14-38
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,22 @@
33
# Blocklists Methods
44
| Method | Description |
55
| ------ | ----------- |
6-
| [get_blocklists](#get_blocklists) | Get multiple blocklists. Only blocklists owned by your organization,
7-
shared with your organization or public blocklists are returned. Filters and pagination are available as query parameters. |
8-
| [create_blocklist](#create_blocklist) | Create a new blocklist owned by your organization. The name must be unique within your organization.
9-
The list will only be visible to your organization and organizations you shared the blocklist with. This operation is submitted to quotas |
6+
| [get_blocklists](#get_blocklists) | Get multiple blocklists. Only blocklists owned by your organization, shared with your organization or public blocklists are returned. Filters and pagination are available as query parameters. |
7+
| [create_blocklist](#create_blocklist) | Create a new blocklist owned by your organization. The name must be unique within your organization. The list will only be visible to your organization and organizations you shared the blocklist with. This operation is submitted to quotas |
108
| [get_blocklist](#get_blocklist) | Get the details of a blocklist by ID. The content of the blocklist is not returned. |
11-
| [delete_blocklist](#delete_blocklist) | Delete a blocklist by ID. If the blocklist is shared with other organizations or it has subscriptions, the operation will fail.
12-
If you want to force delete the blocklist, you can use the force query parameter, so the blocklists will be unshared / unsubscribed. |
9+
| [delete_blocklist](#delete_blocklist) | Delete a blocklist by ID. If the blocklist is shared with other organizations or it has subscriptions, the operation will fail. If you want to force delete the blocklist, you can use the force query parameter, so the blocklists will be unshared / unsubscribed. |
1310
| [update_blocklist](#update_blocklist) | Update a blocklist's details by ID. It is not possible to update the blocklist content using this operation. |
1411
| [add_ips_to_blocklist](#add_ips_to_blocklist) | Add IPs to a blocklist. If an IP is already in the blocklist, its expiration will be updated with the new expiration. |
1512
| [delete_ips_from_blocklist](#delete_ips_from_blocklist) | Delete IPs from a blocklist |
16-
| [download_blocklist_content](#download_blocklist_content) | Download blocklist content as a list of ips as plain text separated by new lines. The response will include the ETag header for cache control.
17-
If_Modified_Since and If_None_Match cache control headers are supported for conditional requests. |
13+
| [download_blocklist_content](#download_blocklist_content) | Download blocklist content as a list of ips as plain text separated by new lines. The response will include the ETag header for cache control. If_Modified_Since and If_None_Match cache control headers are supported for conditional requests. |
1814
| [get_blocklist_subscribers](#get_blocklist_subscribers) | Get blocklist subscribers within your organization. |
19-
| [subscribe_blocklist](#subscribe_blocklist) | Subscribe to a blocklist with a remediation type. If the entity type is the full organization or a Tag,
20-
all the engines belonging to the organization or the Tag will be subscribed
21-
and new engines that will join the organization or the Tag will also be automatically subscribed.
22-
If the subscription has been done on an organization or Tag you cannot unsubscribe individual engines.
23-
In case of errors for some subscribers, the operation will still succeed for the entities that were successfully subscribed
24-
and you'll have the list of errors in the operation's result.
25-
This operation is submitted to quotas. |
15+
| [subscribe_blocklist](#subscribe_blocklist) | Subscribe to a blocklist with a remediation type. If the entity type is the full organization or a Tag, all the engines belonging to the organization or the Tag will be subscribed and new engines that will join the organization or the Tag will also be automatically subscribed. If the subscription has been done on an organization or Tag you cannot unsubscribe individual engines. In case of errors for some subscribers, the operation will still succeed for the entities that were successfully subscribed and you'll have the list of errors in the operation's result. This operation is submitted to quotas. |
2616
| [unsubscribe_blocklist](#unsubscribe_blocklist) | Unsubscribe from a blocklist. You cannot unsubscribe individual engines if the subscription has been done on an organization or Tag. |
27-
| [share_blocklist](#share_blocklist) | Share a blocklist with other organizations given their IDs. The blocklist must be owned by your organization.
28-
You can give read-only access or read-write access to the blocklist. Sharing a blocklist will not automatically subscribe the shared organizations to the blocklist. |
29-
| [unshare_blocklist](#unshare_blocklist) | Unshare a blocklist with other organizations. If the blocklist is subscribed by the organization, the operation will fail.
30-
Use force query parameter to unshare a blocklist even if subscriptions exists. |
17+
| [share_blocklist](#share_blocklist) | Share a blocklist with other organizations given their IDs. The blocklist must be owned by your organization. You can give read-only access or read-write access to the blocklist. Sharing a blocklist will not automatically subscribe the shared organizations to the blocklist. |
18+
| [unshare_blocklist](#unshare_blocklist) | Unshare a blocklist with other organizations. If the blocklist is subscribed by the organization, the operation will fail.Use force query parameter to unshare a blocklist even if subscriptions exists. |
3119

3220
## **get_blocklists**
33-
### Get multiple blocklists. Only blocklists owned by your organization,
34-
shared with your organization or public blocklists are returned. Filters and pagination are available as query parameters.
21+
### Get multiple blocklists. Only blocklists owned by your organization, shared with your organization or public blocklists are returned. Filters and pagination are available as query parameters.
3522
- Endpoint: `/blocklists`
3623
- Method: `GET`
3724

@@ -73,8 +60,7 @@ print(response)
7360

7461

7562
## **create_blocklist**
76-
### Create a new blocklist owned by your organization. The name must be unique within your organization.
77-
The list will only be visible to your organization and organizations you shared the blocklist with. This operation is submitted to quotas
63+
### Create a new blocklist owned by your organization. The name must be unique within your organization. The list will only be visible to your organization and organizations you shared the blocklist with. This operation is submitted to quotas
7864
- Endpoint: `/blocklists`
7965
- Method: `POST`
8066

@@ -149,8 +135,7 @@ print(response)
149135

150136

151137
## **delete_blocklist**
152-
### Delete a blocklist by ID. If the blocklist is shared with other organizations or it has subscriptions, the operation will fail.
153-
If you want to force delete the blocklist, you can use the force query parameter, so the blocklists will be unshared / unsubscribed.
138+
### Delete a blocklist by ID. If the blocklist is shared with other organizations or it has subscriptions, the operation will fail. If you want to force delete the blocklist, you can use the force query parameter, so the blocklists will be unshared / unsubscribed.
154139
- Endpoint: `/blocklists/{blocklist_id}`
155140
- Method: `DELETE`
156141

@@ -306,8 +291,7 @@ print(response)
306291

307292

308293
## **download_blocklist_content**
309-
### Download blocklist content as a list of ips as plain text separated by new lines. The response will include the ETag header for cache control.
310-
If_Modified_Since and If_None_Match cache control headers are supported for conditional requests.
294+
### Download blocklist content as a list of ips as plain text separated by new lines. The response will include the ETag header for cache control. If_Modified_Since and If_None_Match cache control headers are supported for conditional requests.
311295
- Endpoint: `/blocklists/{blocklist_id}/download`
312296
- Method: `GET`
313297

@@ -379,13 +363,7 @@ print(response)
379363

380364

381365
## **subscribe_blocklist**
382-
### Subscribe to a blocklist with a remediation type. If the entity type is the full organization or a Tag,
383-
all the engines belonging to the organization or the Tag will be subscribed
384-
and new engines that will join the organization or the Tag will also be automatically subscribed.
385-
If the subscription has been done on an organization or Tag you cannot unsubscribe individual engines.
386-
In case of errors for some subscribers, the operation will still succeed for the entities that were successfully subscribed
387-
and you'll have the list of errors in the operation's result.
388-
This operation is submitted to quotas.
366+
### Subscribe to a blocklist with a remediation type. If the entity type is the full organization or a Tag, all the engines belonging to the organization or the Tag will be subscribed and new engines that will join the organization or the Tag will also be automatically subscribed. If the subscription has been done on an organization or Tag you cannot unsubscribe individual engines. In case of errors for some subscribers, the operation will still succeed for the entities that were successfully subscribed and you'll have the list of errors in the operation's result. This operation is submitted to quotas.
389367
- Endpoint: `/blocklists/{blocklist_id}/subscribers`
390368
- Method: `POST`
391369

@@ -458,8 +436,7 @@ print(response)
458436

459437

460438
## **share_blocklist**
461-
### Share a blocklist with other organizations given their IDs. The blocklist must be owned by your organization.
462-
You can give read-only access or read-write access to the blocklist. Sharing a blocklist will not automatically subscribe the shared organizations to the blocklist.
439+
### Share a blocklist with other organizations given their IDs. The blocklist must be owned by your organization. You can give read-only access or read-write access to the blocklist. Sharing a blocklist will not automatically subscribe the shared organizations to the blocklist.
463440
- Endpoint: `/blocklists/{blocklist_id}/shares`
464441
- Method: `POST`
465442

@@ -496,8 +473,7 @@ print(response)
496473

497474

498475
## **unshare_blocklist**
499-
### Unshare a blocklist with other organizations. If the blocklist is subscribed by the organization, the operation will fail.
500-
Use force query parameter to unshare a blocklist even if subscriptions exists.
476+
### Unshare a blocklist with other organizations. If the blocklist is subscribed by the organization, the operation will fail.Use force query parameter to unshare a blocklist even if subscriptions exists.
501477
- Endpoint: `/blocklists/{blocklist_id}/shares/{unshare_organization_id}`
502478
- Method: `DELETE`
503479

‎doc/Integrations.md

+4-10
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,13 @@
44
| Method | Description |
55
| ------ | ----------- |
66
| [get_integrations](#get_integrations) | Get integrations owned by your organization |
7-
| [create_integration](#create_integration) | Create an integration to a firewall or remediation component, owned by your organization.
8-
The name should be unique within the organization.
9-
This operation is submitted to quotas. |
7+
| [create_integration](#create_integration) | Create an integration to a firewall or remediation component, owned by your organization. The name should be unique within the organization. This operation is submitted to quotas. |
108
| [get_integration](#get_integration) | Get an integration by ID |
119
| [delete_integration](#delete_integration) | Delete the integration by ID |
1210
| [update_integration](#update_integration) | Update the integration details |
1311
| [get_integration_content](#get_integration_content) | Get the ips associated to the integration in plain text format. The content can be paginated to accomodate limits in firewalls. |
1412
| [head_integration_content](#head_integration_content) | Check if the integration has content |
15-
| [get_integration_content_stream](#get_integration_content_stream) | Get the ips associated to the integration in a format compatible with a remediation component.
16-
As for the remediation components, you can fetch the full content with startup=true or only the changes since the last pull |
13+
| [get_integration_content_stream](#get_integration_content_stream) | Get the ips associated to the integration in a format compatible with a remediation component. As for the remediation components, you can fetch the full content with startup=true or only the changes since the last pull |
1714

1815
## **get_integrations**
1916
### Get integrations owned by your organization
@@ -50,9 +47,7 @@ print(response)
5047

5148

5249
## **create_integration**
53-
### Create an integration to a firewall or remediation component, owned by your organization.
54-
The name should be unique within the organization.
55-
This operation is submitted to quotas.
50+
### Create an integration to a firewall or remediation component, owned by your organization. The name should be unique within the organization. This operation is submitted to quotas.
5651
- Endpoint: `/integrations`
5752
- Method: `POST`
5853

@@ -258,8 +253,7 @@ print(response)
258253

259254

260255
## **get_integration_content_stream**
261-
### Get the ips associated to the integration in a format compatible with a remediation component.
262-
As for the remediation components, you can fetch the full content with startup=true or only the changes since the last pull
256+
### Get the ips associated to the integration in a format compatible with a remediation component. As for the remediation components, you can fetch the full content with startup=true or only the changes since the last pull
263257
- Endpoint: `/integrations/{integration_id}/v1/decisions/stream`
264258
- Method: `GET`
265259

0 commit comments

Comments
 (0)